botsense  3.2.0
RoadNarrows Client-Server Proxied Services Framework
zModDoxyIncludes.doxy
Go to the documentation of this file.
1 
2 ////////////////////////////////////////////////////////////////////////////////
3 //
4 // Package: BotSense
5 //
6 // File: zModDoxyIncludes.doxy
7 //
8 // Version:
9 // $LastChangedDate: 2012-02-14 12:39:13 -0700 (Tue, 14 Feb 2012) $
10 // $Rev: 1801 $
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_param_ecode doc_param_ecode
29  * \{
30 One of \ref bs_ecodes "BotSense Error Codes".
31  * \}
32  */
33 
34 /*!
35  * \ingroup doxy_includes
36  * \defgroup doc_return_ecode doc_return_ecode
37  * \{
38 On error, the appropriate \h_lt 0 negated \ref bs_ecodes
39 "BotSense Error Code" is returned.
40  * \}
41  */
42 
43 /*!
44  * \ingroup doxy_includes
45  * \defgroup doc_return_std doc_return_std
46  * \{
47 \return
48 On success, \ref BS_OK is returned.\n
49 On error, the appropriate \h_lt 0 negated \ref bs_ecodes
50 "BotSense Error Code" is returned.
51  * \}
52  */
53 
54 /*! \} end of doxy_includes */