Changeset 210

Show
Ignore:
Timestamp:
02/07/08 14:59:39 (4 years ago)
Author:
uncle_fungus
Message:

doxygenated projectHelperThread

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • branches/2.3.2beta3/src/include/projectHelperThread.h

    r38 r210  
    1515*/ 
    1616 
     17/** 
     18 * \file projectHelperThread.h 
     19 * Manages threads for project database updates. 
     20 * \author François Ingelrest 
     21 * \author Andrew Schofield 
     22 **/ 
     23 
    1724#ifndef _PROJECTHELPERTHREAD_H 
    1825#define _PROJECTHELPERTHREAD_H 
     
    2330 
    2431/** 
    25 * When instanciated, this class: 
    26 *  - Asks the ProjectsManager to update its database 
    27 *  - Sends an EVT_PROJECTS_DATABASE_UPDATED event to the main dialog when done, if no error occurred 
    28 
    29 * This class should only be used by the ProjectsManager 
    30 **/ 
     32 * Manages threads for project database updates. 
     33 * When instanciated, this class: 
     34 *  - Asks the ProjectsManager to update its database 
     35 *  - Sends an EVT_PROJECTS_DATABASE_UPDATED event to the main dialog when done, if no error occurred 
     36 * 
     37 * This class should only be used by the ProjectsManager 
     38 **/ 
    3139class ProjectHelperThread : public wxThread 
    3240{ 
    3341protected: 
    34         bool mIsForced; 
    35         bool mIsInSilentMode; 
     42        bool mIsForced; /**< Was the update forced? */ 
     43        bool mIsInSilentMode; /**< Should the update be verbose? */ 
    3644 
     45        /** 
     46         * This is the entry point of the thread, where the database is updated. 
     47         **/ 
    3748        void* Entry(void); 
    3849 
    3950 
    4051public: 
     52        /** 
     53         * Constructor. 
     54         * Contructs the thread launcher. 
     55         * @param isForced Was the update forced? 
     56          *@param isInSilentMode Should we be verbose? 
     57         **/ 
    4158        ProjectHelperThread(bool isForced, bool isInSilentMode); 
    4259}; 
  • branches/2.3.2beta3/src/projectHelperThread.cpp

    r148 r210  
    1515*/ 
    1616 
     17/** 
     18 * \file projectHelperThread.cpp 
     19 * Manages threads for project database updates. 
     20 * \author François Ingelrest 
     21 * \author Andrew Schofield 
     22 **/ 
     23 
    1724#include "projectHelperThread.h" 
    1825#include "fahmon.h" 
     
    2229 
    2330 
    24 /** 
    25 * Constructor 
    26 **/ 
    2731ProjectHelperThread::ProjectHelperThread(bool isForced, bool isInSilentMode) : wxThread(wxTHREAD_DETACHED) 
    2832{ 
     
    3539 
    3640 
    37 /** 
    38 * This is the entry point of the thread, where the database is updated 
    39 **/ 
    4041void* ProjectHelperThread::Entry(void) 
    4142{