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