Hekateros  3.4.3
RoadNarrows Robotics Robot Arm Project
zModDoxyIncludes.doxy
Go to the documentation of this file.
1 
2 ////////////////////////////////////////////////////////////////////////////////
3 //
4 // Package: Hekateros
5 //
6 // File: zModDoxyIncludes.doxy
7 //
8 // Version:
9 // $LastChangedDate: 2014-02-10 08:51:10 -0700 (Mon, 10 Feb 2014) $
10 // $Rev: 3518 $
11 //
12 // Description:
13 // Useful Documentation Include Blocks (see \copydoc)
14 //
15 ////////////////////////////////////////////////////////////////////////////////
16 
17 /*!
18  * \file
19  * \dontinclude
20  */
21 
22 /*!
23  * \defgroup doxy_includes Doxygen Includes
24  * Useful doxygen documentation blocks that can be included into other
25  * documentation with the <b>\\copydoc</b> command.
26  * \{
27  */
28 
29 /*!
30  * \ingroup doxy_includes
31  * \defgroup doc_param_ecode doc_param_ecode
32  * \{
33 One of \ref hek_ecodes "Hekateros Error Codes".
34  * \}
35  */
36 
37 /*!
38  * \ingroup doxy_includes
39  * \defgroup doc_return_ecode doc_return_ecode
40  * \{
41 On error, the appropriate \h_lt 0 negated \ref hek_ecodes
42 "Hekateros Error Code" is returned.
43  * \}
44  */
45 
46 /*!
47  * \ingroup doxy_includes
48  * \defgroup doc_return_std doc_return_std
49  * \{
50 \return
51 On success, \ref hekateros::HEK_OK "HEK_OK" is returned.\n
52 On error, the appropriate \h_lt 0 negated \ref hek_ecodes
53 "Hekateros Error Code" is returned.
54  * \}
55  */
56 
57 /*!
58  * \ingroup doxy_includes
59  * \defgroup doc_return_py_ecode doc_return_py_ecode
60  * \{
61 On error, the appropriate \h_lt 0 negated Hekateros.HekCore error code is
62 returned.
63  * \}
64  */
65 
66 /*!
67  * \ingroup doxy_includes
68  * \defgroup doc_return_py_std doc_return_py_std
69  * \{
70 \return
71 On success, Hekateros.HekCore.HEK_OK is returned.\n
72 On error, the appropriate \h_lt 0 negated Hekateros.HekCore error code is
73 returned.
74  * \}
75  */
76 
77 /*!
78  * \ingroup doxy_includes
79  * \defgroup doc_return_bs_ecode doc_return_bs_ecode
80  * \{
81 On error, the appropriate \h_lt 0 negated BotSense error code is returned.
82  * \}
83  */
84 
85 /*!
86  * \ingroup doxy_includes
87  * \defgroup doc_return_bs_std doc_return_bs_std
88  * \{
89 \return
90 On success, BS_OK is returned.\n
91 On error, the appropriate \h_lt 0 negated BotSense error code is returned.
92  * \}
93  */
94 
95 /*!
96  * \ingroup doxy_includes
97  * \defgroup doc_args_std doc_args_std
98  * \{
99  *
100  * \termblock
101  * \term \n Standard Options: \endterm
102  * \term -l, --log=<level>
103  * \termdata Set logging threshold level.\n
104  * All logging events with priority <= <em>level</em> \n will be logged.
105  * All others will be ignored.\n Error events are always logged.\n
106  * <em>level</em> is one of:
107  * \termblock
108  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b off' or 0
109  * \termdata Disable all logging.
110  * \endterm
111  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b error' or 1
112  * \termdata Enable error logging.
113  * \endterm
114  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b diag1' or 2
115  * \termdata Enable diagnostics 1 logging.
116  * \endterm
117  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b diag2' or 3
118  * \termdata Enable diagnostics 2 logging.
119  * \endterm
120  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b diag3' or 4
121  * \termdata Enable diagnostics 3 logging.
122  * \endterm
123  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b diag4' or 5
124  * \termdata Enable diagnostics 4 logging.
125  * \endterm
126  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b diag5' or 6
127  * \termdata Enable diagnostics 5 logging.
128  * \endterm
129  * \term &nbsp;&nbsp;&nbsp;&nbsp; \b >6
130  * \termdata Enable user-defined logging.
131  * \endterm
132  * \endtermblock
133  * \termdata DEFAULT: off
134  * \endterm
135  * \term &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--logfile=<file>
136  * \termdata Set logfile <em>file</em>.
137  * \termdata DEFAULT: stderr
138  * \endterm
139  * \term &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--help
140  * \termdata Display help and exit.
141  * \endterm
142  * \term &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--version
143  * \termdata Display hek version number and exit.
144  * \endterm
145  * \}
146  */
147 
148 /*! \} end of doxy_includes */