Commit 0431de44 authored by Christophe Courtaut's avatar Christophe Courtaut
Browse files

Added documentation on code

parent 45c4d328
......@@ -26,9 +26,18 @@
#include <QFileInfo>
#include <QListWidgetItem>
/**
* class ListViewMediaItem
* brief Items class to use inside MediaListView widget
*/
class ListViewMediaItem : public QListWidgetItem
{
public:
/**
* enum fType
* brief enum to determine file type
*/
enum fType
{
Audio,
......@@ -36,13 +45,42 @@ public:
Image
};
/**
* brief Constructor
*
* param fileInfo the QFileInfo refering to the file
* param fType the type of the media
* param parent parent widget
* param type
*/
ListViewMediaItem( QFileInfo* fileInfo, ListViewMediaItem::fType fType, QListWidget* parent = 0, int type = Type );
/**
* brief Destructor
*/
virtual ~ListViewMediaItem();
/**
* brief Getter for fileinfo
* return fileInfo of the item
*/
QFileInfo* fileInfo() { return m_fileInfo; }
/**
* brief Getter for filetype
* return filetype of the item
*/
ListViewMediaItem::fType fileType() { return m_fileType; }
private:
/**
* brief fileInfo member
*/
QFileInfo* m_fileInfo;
/**
* brief fileType member
*/
ListViewMediaItem::fType m_fileType;
};
......
......@@ -23,9 +23,17 @@
#include <QApplication>
#include "gui/MainWindow.h"
/**
* VLMC Entry point
* brief this is the VLMC entry point
* param argc
* param argv
* return Return value of vlmc
*/
int main( int argc, char **argv )
{
QApplication app( argc, argv );
QApplication app( argc, argv );
app.setApplicationName( "vlmc" );
app.setOrganizationName( "vlmc" );
app.setOrganizationDomain( "vlmc.org" );
......@@ -33,5 +41,5 @@ int main( int argc, char **argv )
Preferences::changeLang( QSettings().value( "Lang" ).toString() );
MainWindow w;
w.show();
return app.exec();
return app.exec();
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment