Commit 8d5dab54 authored by Vincent Carrubba's avatar Vincent Carrubba

Add of some /* \file */ doxygen comments

It's my first commit WOOOT, yay 1337 powned
parent 6935eb22
/*****************************************************************************
/*****************``************************************************************
* Clip.cpp: Represents a basic container for media informations.
*****************************************************************************
* Copyright (C) 2008-2009 the VLMC team
......@@ -20,6 +20,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/** \file
* This file contains the Clip class implementation.
* It contains a VLCMedia and the meta-datas.
* It's used by the Library
*/
#include <QtDebug>
#include "Clip.h"
......
......@@ -20,6 +20,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/** \file
* This file contains the Clip class declaration/definition.
* It contains a VLCMedia and the meta-datas.
* It's used by the Library
*/
#ifndef CLIP_H__
#define CLIP_H__
......
......@@ -20,6 +20,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/** \file
* This file the library contains class implementation.
* It's the the backend part of the Library widget of vlmc.
* It can load and unload Clips (Clip.h/Clip.cpp)
*/
#include <QtDebug>
#include "Library.h"
#include "Clip.h"
......
......@@ -20,6 +20,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/** \file
* This file the library contains class declaration/definition.
* It's the the backend part of the Library widget of vlmc.
* It can load and unload Clips (Clip.h/Clip.cpp)
*/
#ifndef LIBRARY_H
#define LIBRARY_H
......
/** \file
* This file contains the MetaDataManager class implementation.
* It used by the library in Library.[hc]pp.
* It parse a Clip (see in Clip.[hc]pp) to get meta-data like length, first image, etc.
*/
#include <QtDebug>
#include "MetaDataManager.h"
#include "Library.h"
......
/** \file
* This file contains the MetaDataManager class declaration/definition.
* It used by the library in Library.[hc]pp.
* It parse a Clip (see in Clip.[hc]pp) to get meta-data like length, first image, etc.
*/
#ifndef METADATAMANAGER_H
#define METADATAMANAGER_H
......
/** \file
* This file contain the templated singleton.
* Class/struct to be singletonized just have to
* iherit from this classe with the class/struct type in template
* parameter.You have to do few other things, but you know your job,
* isnt'it :) ?
*/
#ifndef SINGLETON_HPP
#define SINGLETON_HPP
......
......@@ -20,6 +20,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/** \file
* This file contain the main function.
* It will initialize the QT application,
* and start it.
*/
#include <QApplication>
#include "gui/MainWindow.h"
......
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