Index: main.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- main.cpp (.../main.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ main.cpp (.../main.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -15,10 +15,16 @@ /*! * \mainpage UI Software Design Description - * \section Detailed Description + * \details Detailed Description.\n * This document has been generated by Doxygen.\n * This document describes the detail description of the UI Application Software design.\n - * UI Application starts by Application Initialization which happens in \ref main.cpp "Initialization section".\n + * UI Application starts by Application Initialization which happens in \ref main() "Application Initialization".\n + * For information please see : + * - \ref main() + * - \subpage CommandLineSwitches + * - \subpage DenaliMessageStructure + * - \subpage MessageFlow + * - \subpage MessageView */ // Qt @@ -31,16 +37,16 @@ #include // Project -#include "maintimer.h" -#include "caninterface.h" -#include "frameinterface.h" -#include "messageacknowmodel.h" -#include "messagedispatcher.h" -#include "applicationcontroller.h" -#include "guicontroller.h" -#include "logger.h" +#include "MainTimer.h" +#include "CanInterface.h" +#include "FrameInterface.h" +#include "MessageAcknowModel.h" +#include "MessageDispatcher.h" +#include "ApplicationController.h" +#include "GuiController.h" +#include "Logger.h" #include "DriveWatcher.h" -#include "threads.h" +#include "Threads.h" // kernel #include @@ -76,26 +82,32 @@ bool gConsoleoutCanInterface = false ; /*! - * \brief commandlineParse - * \details parses the command line arguments \n - * Usage: ./denali [options] \n - * Denali \n - * \n - * Options: \n - * -h, --help Displays this help. \n - * -v, --version Displays version information. \n - * -c, --canOut Show the Can Frame Output \n - * -m, --msgOut Show the Message Output \n - * -0, --enable-keep-awake Enable send low priority, empty message on \n - * the CANBus just to keep UI board CAN driver \n - * awake \n - * -i, --fake-interval Test fake message interval(ms) \n - * -f, --fake-message Test fake message data \n - * will use default sequenced long fake message \n - * if set to 00(default) \n - * will used only if correct intger value \n - * assigned for interval option \n + * \page CommandLineSwitches Denali Command Line Switches + * \verbatim + * Usage: ./denali [options] + * Denali + * + * Options: + * -h, --help Displays this help. + * -v, --version Displays version information. + * -c, --canOut Show the Can Frame Output + * -m, --msgOut Show the Message Output + * -0, --enable-keep-awake Enable send low priority, empty message on + * the CANBus just to keep UI board CAN driver + * awake + * -i, --fake-interval Test fake message interval(ms) + * -f, --fake-message Test fake message data + * will use default sequenced long fake message + * if set to 00(default) + * will used only if correct integer value + * assigned for interval option + * \endverbatim */ +/*! + * \brief commandlineParse + * \details parses the command line arguments + * \ref CommandLineSwitches + */ void commandlineParse() { QCommandLineParser parser; parser.setApplicationDescription(QApplication::applicationName()); @@ -214,10 +226,11 @@ #include TEST_CLASS_INCLUDE QTEST_MAIN(TEST_CLASS_NAME) #else -/*! \brief Application Initialization\n - * Some part of the application need to be initialized out of any thread. - * So is initialized here to be initialized in the main thread. - * this section also includes: +/*! + * \brief Application Initialization + * \details Some part of the application need to be initialized out of any thread. + * So is initialized here to be initialized in the main thread. + * this section also includes: */ int main(int argc, char *argv[]) { @@ -271,21 +284,21 @@ " \n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ "); } - //! - Initializing USB Watcher + //! - Initializing the Drive Watcher _DriveWatcher.init(Threads::_DriveWatcher_Thread); - //! - Initializing CanBus Interface + //! - Initializing the CANBus Interface if (_CanInterface.init(Threads::_CanFrame_Thread)) { _CanInterface.enableConsoleOut(gConsoleoutCanInterface); } - //! - Initializing CanBus Message Handler + //! - Initializing the CANBus Message Handler _FrameInterface.init(Threads::_CanFrame_Thread); - //! - Initializing the CanBus Message Acknowledgment Model + //! - Initializing the CANBus Message Acknowledgment Model _MessageAcknowModel.init(Threads::_CanAcknow_Thread); - //! - Initializing CanBus Message Dispatcher + //! - Initializing the CANBus Message Dispatcher if (_MessageDispatcher.init(Threads::_CanMessage_Thread)) { _MessageDispatcher.enableConsoleOut(gConsoleoutFrameInterface); } @@ -300,7 +313,7 @@ _MainTimer.init(); - //! - Initialize the Qml Viewer and starts GUI + //! - Initialize the QML Viewer and starts GUI int app_exec = -1; LOG_DEBUG("UI Initializing"); if ( startGui() ) {