Changeset 61 in pacpusframework for trunk/src


Ignore:
Timestamp:
01/09/13 13:40:39 (11 years ago)
Author:
Marek Kurdej
Message:

Added: some documentation and doc todo comments.

Location:
trunk/src/PacpusSensor/src
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/PacpusSensor/src/main.cpp

    r31 r61  
    1717#ifdef WIN32
    1818#   include <windows.h>
    19 #   include <mmsystem.h>
    2019#endif
    2120
  • trunk/src/PacpusSensor/src/ui/pacpusmainwindow.cpp

    r32 r61  
    2727
    2828//////////////////////////////////////////////////////////////////////////
    29 /// Constructor
    3029PacpusMainWindow::PacpusMainWindow(QWidget * parent)
    3130    : QDialog(parent)
     
    6362
    6463//////////////////////////////////////////////////////////////////////////
    65 /// Destructor
    6664PacpusMainWindow::~PacpusMainWindow()
    6765{
     
    7068
    7169//////////////////////////////////////////////////////////////////////////
    72 /// slot
    73 /// Starts all the components and checks all the checkbox
    7470void PacpusMainWindow::startAcquisition()
    7571{
     
    8076
    8177//////////////////////////////////////////////////////////////////////////
    82 /// slot
    83 /// Stops all the components and unchecks all the checkbox
    8478void PacpusMainWindow::stopAcquisition()
    8579{
     
    8983}
    9084
    91 //////////////////////////////////////////////////////////////////////////
    92 // slot
    93 // called when a checkbox is checked
    94 // start the corresponding component
    95 // start the monitoring loop if not running
    9685//////////////////////////////////////////////////////////////////////////
    9786void PacpusMainWindow::startComponent(QString component)
     
    114103
    115104//////////////////////////////////////////////////////////////////////////
    116 /// slot
    117 /// called when a checkbox is unchecked
    118 /// stop the corresponding component
    119 /// eventually stop the monitoring loop if any other component is active
    120105void PacpusMainWindow::stopComponent(QString component)
    121106{
     
    145130//////////////////////////////////////////////////////////////////////////
    146131
    147 // Voir si besoin de faire un thread : un timer est peut être suffisant ??
     132/// @todo Voir si besoin de faire un thread : un timer est peut être suffisant ??
    148133void PacpusMainWindow::monitoring()
    149134{
  • trunk/src/PacpusSensor/src/ui/pacpusmainwindow.h

    r32 r61  
    3333
    3434public:
     35    /// @todo Documentation
    3536    ComponentCheckBox(const QString & text, QWidget * parent, const char * /*name*/ = 0 )
    3637        : QCheckBox(text, parent)
     
    4041    }
    4142
     43    /// @todo Documentation
    4244    ~ComponentCheckBox()
    4345    {
     
    4547
    4648public Q_SLOTS:
     49    /// @todo Documentation
    4750    void change(bool state)
    4851    {
     
    5558
    5659Q_SIGNALS:
     60    /// @todo Documentation
    5761    void activate(QString);
     62    /// @todo Documentation
    5863    void deactivate(QString);
    5964};
    6065
    6166////////////////////////////////////////////////////////////////////////////////
     67/// @todo Documentation
    6268class PacpusMainWindow
    6369        : public QDialog
     
    6773
    6874public:
     75    /// Constructor
    6976    PacpusMainWindow(QWidget * parent = 0);
     77    /// Destructor
    7078        ~PacpusMainWindow();
    7179
    7280public Q_SLOTS:
     81    /// slot
     82    /// Starts all the components and checks all the checkbox
    7383    void startAcquisition();
     84    /// slot
     85    /// called when a checkbox is checked
     86    /// start the corresponding component
     87    /// start the monitoring loop if not running
    7488    void startComponent(QString component);
    75 
     89   
     90    /// slot
     91    /// Stops all the components and unchecks all the checkbox
    7692    void stopAcquisition();
     93    /// slot
     94    /// called when a checkbox is unchecked
     95    /// stop the corresponding component
     96    /// eventually stop the monitoring loop if any other component is active
    7797    void stopComponent(QString component);
    7898
     99    /// @todo Documentation
    79100    void monitoring();
    80101
Note: See TracChangeset for help on using the changeset viewer.