Project Documentation Manager BRIGADOON-0002
Project Documentation Manager
Loading...
Searching...
No Matches
doxygenmanager.h
Go to the documentation of this file.
1
7
8#ifndef DOXYGENMANAGER_H
9#define DOXYGENMANAGER_H
10
11#include <QLinkedList>
12#include <QObject>
13#include <QThread>
14#include "logger.h"
15#include "worker.h"
16#include "common_definitions.h"
17
18
23class DoxygenManager : public QObject
24{
25 Q_OBJECT
26
32
33public:
34
40
46
51 void ProcessProject(PROJECT_INFORMATION* ProjectInfo);
52
53public slots:
54
59 void ReceiveResult(PROJECT_INFORMATION *ProjectInfo);
60
61private:
62
70 void LogAdd(LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message);
71
76 QList<PROJECT_INFORMATION*> project_list;
77
83 bool LockProject(int ProjectIndex);
84
89 void DoProject(void);
90
96
101 bool project_working = false;
102
103private slots:
104
105 /* \fn void RemoteLogger(REMOTE_LOG_ENTRY LogEntry)
106 * \brief Receive Log Commands for processing & Sending
107 *
108 */
109 void RemoteLogger(REMOTE_LOG_ENTRY LogEntry);
110
111signals:
112
119
124 void DoxygenDone(void);
125
132
138 void DoWork(PROJECT_INFORMATION* ProjectInfo);
139};
140
141#endif // DOXYGENMANAGER_H
bool project_working
Flag showing is a project is being processed.
void ReceiveResult(PROJECT_INFORMATION *ProjectInfo)
Receive the Result of the Worker Function.
void PrStateChange(PROJECT_INFORMATION *ProjectInfo)
Signal that State of the Project has changed.
~DoxygenManager()
Class Deconstructor.
void RemoteLogger(REMOTE_LOG_ENTRY LogEntry)
void SendLogEntry(REMOTE_LOG_ENTRY LogEntry)
Send Log Entry to the Log \LogEntry Structure holding Log information.
bool LockProject(int ProjectIndex)
Lock the Project to prevent alterations.
void ProcessProject(PROJECT_INFORMATION *ProjectInfo)
Process documentation for a Project.
void DoxygenDone(void)
Signal Doxgen has finished a task.
QList< PROJECT_INFORMATION * > project_list
Queue of Projects to be processed.
void DoProject(void)
Take the next Project in the Queue and process.
void DoWork(PROJECT_INFORMATION *ProjectInfo)
Signal the Work task to process this Project.
DoxygenManager()
Class Constructor.
void LogAdd(LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message)
Add a Log Entry.
Thread to remove lengthy process from user interface loop.
Instantiate the Thread Worker Class.
Common Structure Defintitions.
LOGGING_SEVERITY
Log Severity allow the selection of logging events based on Severity.
Definition logger.h:48
LOGGING_MODE
Log Severity allow the selection of logging events based on the mode.
Definition logger.h:21
Project Information Passed Between Functions.
Definition logger.h:60