appkit  1.5.1
RoadNarrows Robotics Application Kit
zModDoxyIncludes.doxy
Go to the documentation of this file.
1 
2 ////////////////////////////////////////////////////////////////////////////////
3 //
4 // Package: appkit
5 //
6 // File: zModDoxyIncludes.doxy
7 //
8 /*!
9  \file
10  $LastChangedDate: 2013-04-27 09:31:41 -0600 (Sat, 27 Apr 2013) $
11  $Rev: 2877 $
12 */
13 //
14 // Description:
15 // Useful Documentation Include Blocks (see \copydoc)
16 ////////////////////////////////////////////////////////////////////////////////
17 
18 /*!
19  * \defgroup doxy_includes Doxygen Includes
20  * Useful doxygen documentation blocks that can be included into other
21  * documentation with the <b>\\copydoc</b> command.
22  * \{
23  */
24 
25 /*!
26  * \ingroup doxy_includes
27  * \defgroup doc_return_std doc_return_std
28  * \{
29 \return
30 On success, OK(0) is returned.\n
31 On error, RC_ERROR(-1) is returned.
32  * \}
33  */
34 
35 /*!
36  * \ingroup doxy_includes
37  * \defgroup doc_return_usb doc_return_py_ecode
38  * \{
39 On error, the appropriate \h_lt 0 negated MIRE.MIRECore error code is returned.
40  * \}
41  */
42 
43 /*!
44  * \ingroup doxy_includes
45  * \defgroup doc_return_usb doc_return_usb
46  * \{
47 \return
48 On success, USBLIB_SUCCESS(0) is returned.\n
49 On error, the appropriate \h_lt 0 USBLIB_ERROR_* code is returned.
50  * \}
51  */
52 
53 /*!
54  * \ingroup doxy_includes
55  * \defgroup doc_return_cl doc_return_cl
56  * \{
57 \return
58 On success, AOk(0) is returned.
59 On error, a CommandLine error code (< 0) is returned.
60 See \ref getErroStr() and backtrace() to retrieve or print error(s).
61  * \}
62  */
63 
64 /*!
65  * \ingroup doxy_includes
66  * \defgroup doc_return_ssize doc_return_ssize
67  * \{
68 \return
69 On success, returns size (count).
70 On error, a CommandLine error code (< 0) is returned.
71 See \ref getErroStr() and backtrace() to retrieve or print error(s).
72  * \}
73  */
74 
75 /*!
76  * \ingroup doxy_includes
77  * \defgroup doc_args_std doc_args_std
78  * \{
79  * \termblock
80  * \term \n Standard Options: \term
81  * \term -l, --log=<level>
82  * \termdata Set logging threshold level.\n
83  * All logging events with priority <= <\b level > \n will be logged.
84  * All others will be ignored.\n Error events are always logged.\n
85  * <level> is one of:
86  * \termblock
87  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b off' or 0
88  * \termdata Disable all logging.
89  * \endterm
90  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b error' or 1
91  * \termdata Enable error logging.
92  * \endterm
93  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b diag1' or 2
94  * \termdata Enable diagnostics 1 logging.
95  * \endterm
96  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b diag2' or 3
97  * \termdata Enable diagnostics 2 logging.
98  * \endterm
99  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b diag3' or 4
100  * \termdata Enable diagnostics 3 logging.
101  * \endterm
102  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b diag4' or 5
103  * \termdata Enable diagnostics 4 logging.
104  * \endterm
105  * \term &nbsp;&nbsp;&nbsp;&nbsp; '\b diag5' or 6
106  * \termdata Enable diagnostics 5 logging.
107  * \endterm
108  * \term &nbsp;&nbsp;&nbsp;&nbsp; \b >6
109  * \termdata Enable user-defined logging.
110  * \endterm
111  * \endtermblock
112  * \termdata DEFAULT: \b off
113  * \endtermblock
114  * \term --logfile=<file>
115  * \termdata Set logfile <file>.
116  * \termdata DEFAULT: \b stderr
117  * \endterm
118  * \term --help
119  * \termdata Display help and exit.
120  * \endterm
121  * \term --version
122  * \termdata Display mire version number and exit.
123  * \endterm
124  * \}
125  */
126 
127 /*! \} end of doxy_includes */