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