diff src/constants.h @ 66:098a10fc2e83 0.9.2

Add doxygen files and improve doxygen comments
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 21 May 2015 15:21:47 +0200
parents c4a5ef6db895
children 5923d569167b
line wrap: on
line diff
--- a/src/constants.h	Thu May 21 14:30:56 2015 +0200
+++ b/src/constants.h	Thu May 21 15:21:47 2015 +0200
@@ -8,12 +8,14 @@
  * See LICENSE.txt for details.
  */
 
-/** @file Common definitions for this project.
+/** @file constants.h
+ * @brief Common definitions for this project.
  *
- * This file can be included to pull in common
+ * @details This file can be included to pull in common
  * definitions in the application. */
 
-/**@def The version of the software package.
+/**
+ * @brief The version of the software package.
  *
  * Usually defined as Build parameter.
  */
@@ -21,7 +23,8 @@
 #define VERSION "0.0.1"
 #endif
 
-/**@def The user visible application name.
+/**
+* @brief The user visible application name.
  *
  * Usually defined as Build parameter.
  **/
@@ -29,76 +32,99 @@
 #define APPNAME "unknown"
 #endif
 
-/**@def Short command line description. */
+/**
+* @brief Short command line description. */
 #define DESCRIPTION "A tool to replay recorded user sessions."
 
-/**@def Short copyright notice to show users. */
+/**
+* @brief Short copyright notice to show users. */
 #define COPYRIGHT "Copyright (C) 2015 ETH Zürich \n\n" \
                   "This file is Free Software under the GNU GPL (v>=2)\n" \
                   "and comes with ABSOLUTELY NO WARRANTY!\n"
 
-/**@def the config key for the last selected root folder. */
+/**
+* @brief the config key for the last selected root folder. */
 #define ROOT_FOLDER_KEY "RootFolder"
 
-/**@def the config key for the root folder info pattern. */
+/**
+* @brief the config key for the root folder info pattern. */
 #define ROOT_FOLDER_PATTERN_KEY "RootFolderPattern"
 
-/**@def the default value for the root folder pattern */
+/**
+* @brief the default value for the root folder pattern */
 #define DEFAULT_ROOT_PATTERN "Datum_Fachnummr_Batch-Nr."
 
-/**@def the config key for the last selected subfolder. */
+/**
+* @brief the config key for the last selected subfolder. */
 #define SUB_FOLDER_KEY "SubFolder"
 
-/**@def the config key for the sub folder info pattern. */
+/**
+* @brief the config key for the sub folder info pattern. */
 #define SUB_FOLDER_PATTERN_KEY "SubFolderPattern"
 
-/**@def the default value for the sub folder pattern */
+/**
+* @brief the default value for the sub folder pattern */
 //#define SUB_FOLDER_PATTERN "IP-Addr_Nethz-Login"
 #define SUB_FOLDER_PATTERN "IP-Addr"
 
-/**@def how to format a timestamp */
+/**
+* @brief how to format a timestamp */
 #define LONG_DATE_FORMAT "dd.MM.yyyy, hh:mm:ss.zzz"
 
-/**@def the config key for the replay speed */
+/**
+* @brief the config key for the replay speed */
 #define REPLAY_SPEED_KEY "Speed"
 
-/**@def the default value for the replay speed in seconds */
+/**
+* @brief the default value for the replay speed in seconds */
 #define REPLAY_SPEED_DEFAULT 1.
 
-/**@def the value for a step in the speed slider */
+/**
+* @brief the value for a step in the speed slider */
 #define REPLAY_SPEED_STEP_MS 500
 
-/**@def The seperator used in the patterns. */
+/**
+* @brief The seperator used in the patterns. */
 #define PATTERN_SEPERATOR "_"
 
-/**@def The default sort column */
+/**
+* @brief The default sort column */
 #define SORT_COLUMN_KEY "Sort"
 
-/**@def The default value for the sort column */
+/**
+* @brief The default value for the sort column */
 #define SORT_COLUMN_DEFAULT "Date"
 
-/**@def The default sort order (boolean) */
+/**
+* @brief The default sort order (boolean) */
 #define SORT_ORDER_KEY "SortAscending"
 
-/**@def The default sort order value. */
+/**
+* @brief The default sort order value. */
 #define SORT_ORDER_VALUE true
 
-/**@def The column to use (counted from 0 and including index nr) for the filename */
+/**
+* @brief The column to use (counted from 0 and including index nr) for the filename */
 #define FILENAME_COLUMN_IDX 1
 
-/**@def The column to use as the timestamp in the player window */
+/**
+* @brief The column to use as the timestamp in the player window */
 #define DATE_COLUMN_KEY "DisplayDate"
 
-/**@def The default value for the timestamp column */
+/**
+* @brief The default value for the timestamp column */
 #define DATE_COLUMN_DEFAULT "Date"
 
-/**@def The fallback value in case the DisplayDate column can't be found */
+/**
+* @brief The fallback value in case the DisplayDate column can't be found */
 #define DATE_COLUMN_FALLBACK_IDX 2
 
-/**@def Setting to control wether or not the image can be detached. */
+/**
+* @brief Setting to control wether or not the image can be detached. */
 #define DETACHABLE_IMAGE_KEY "DetachableImage"
 
-/**@def Default value for the detachable image. */
+/**
+* @brief Default value for the detachable image. */
 #define DETACHABLE_IMAGE_DEFAULT false
 
 #endif // CONSTANTS_H
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)