Commit 1137f3cf authored by Stéphane Albert's avatar Stéphane Albert

DOC: Added section delimitting comments to mvdMyClass and mvdMyWidget template files.

parent d2202a89
......@@ -24,6 +24,10 @@
//// Included at first position before any other ones.
#include "ConfigureMonteverdi2.h"
/*****************************************************************************/
/* INCLUDE SECTION */
//
// Qt includes (sorted by alphabetic order)
//// Must be included before system/custom includes.
......@@ -41,6 +45,10 @@
//
// Monteverdi includes (sorted by alphabetic order)
/*****************************************************************************/
/* PRE-DECLARATION SECTION */
//
// External classes pre-declaration.
namespace
......@@ -52,12 +60,19 @@ namespace mvd
//
// Internal classes pre-declaration.
/*****************************************************************************/
/* CLASS DEFINITION SECTION */
/**
* \class MyClass
*/
class Monteverdi2_EXPORT MyClass :
public QObject
{
/*-[ QOBJECT SECTION ]-----------------------------------------------------*/
Q_OBJECT;
//
......@@ -70,10 +85,14 @@ public:
/** Destructor */
virtual ~MyClass();
/*-[ SIGNALS SECTION ]-----------------------------------------------------*/
//
// SIGNALS.
// Signals.
signals:
/*-[ PROTECTED SECTION ]---------------------------------------------------*/
//
// Protected methods.
protected:
......@@ -82,6 +101,8 @@ protected:
// Protected attributes.
protected:
/*-[ PRIVATE SECTION ]-----------------------------------------------------*/
//
// Private methods.
private:
......@@ -91,8 +112,10 @@ private:
// Private attributes.
private:
/*-[ PRIVATE SLOTS SECTION ]-----------------------------------------------*/
//
// SLOTS.
// Slots.
private slots:
};
......
......@@ -24,6 +24,10 @@
//// Included at first position before any other ones.
#include "ConfigureMonteverdi2.h"
/*****************************************************************************/
/* INCLUDE SECTION */
//
// Qt includes (sorted by alphabetic order)
//// Must be included before system/custom includes.
......@@ -41,6 +45,10 @@
//
// Monteverdi includes (sorted by alphabetic order)
/*****************************************************************************/
/* PRE-DECLARATION SECTION */
//
// External classes pre-declaration.
namespace
......@@ -56,14 +64,23 @@ namespace Ui
class MyWidget;
};
/*****************************************************************************/
/* CLASS DEFINITION SECTION */
/**
* \class MyWidget
*/
class Monteverdi2_EXPORT MyWidget :
public QWidget
{
/*-[ QOBJECT SECTION ]-----------------------------------------------------*/
Q_OBJECT;
/*-[ PUBLIC SECTION ]------------------------------------------------------*/
//
// Public methods.
public:
......@@ -74,10 +91,14 @@ public:
/** Destructor */
virtual ~MyWidget();
/*-[ SIGNALS SECTION ]-----------------------------------------------------*/
//
// SIGNALS.
// Signals.
signals:
/*-[ PROTECTED SECTION ]---------------------------------------------------*/
//
// Protected methods.
protected:
......@@ -90,6 +111,8 @@ protected:
// Private methods.
private:
/*-[ PRIVATE SECTION ]-----------------------------------------------------*/
//
// Private attributes.
private:
......@@ -98,8 +121,10 @@ private:
*/
Ui::MyWidget* m_UI;
/*-[ PRIVATE SLOTS SECTION ]-----------------------------------------------*/
//
// SLOTS.
// Slots.
private slots:
};
......
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