netmsgs  1.2.2
RoadNarrows Robotics Network Messaging Package
zModDoxyIncludes.doxy
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // Package: netmsgs
4 //
5 // File: zModDoxyIncludes.doxy
6 //
7 // Version:
8 // $LastChangedDate%
9 // $Rev%
10 //
11 // Description:
12 // Useful Documentation Include Blocks (see \copydoc)
13 //
14 ////////////////////////////////////////////////////////////////////////////////
15 
16 /*! \file */
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_params_pack_std doc_params_pack_std
28  * \{
29 \param [in] val Value to pack.
30 \param [out] buf Output message buffer.
31 \param bufSize Size of output buffer.
32 \param eEndian Packing order. See \ref NMEndian_T.
33  * \}
34  */
35 
36 /*!
37  * \ingroup doxy_includes
38  * \defgroup doc_params_pack_fdef doc_params_pack_fdef
39  * \{
40 \param pFieldDef Pointer to message field definition.
41 \param [in] pVal Pointer to (typecasted) value to pack.
42 \param [out] buf Output message buffer.
43 \param bufSize Size of output buffer.
44 \param eEndian Packing order. See \ref NMEndian_T.
45 \param pCtl Internal control.
46  * \}
47  */
48 
49 /*!
50  * \ingroup doxy_includes
51  * \defgroup doc_return_pack_std doc_return_pack_std
52  * \{
53 \return
54 On success, returns the number of bytes packed.
55 On error, the appropriate negated
56 \ref man_libnetmsgs_ecodes "netmsgs error code" (\h_lt 0) is returned.
57  * \}
58  */
59 
60 /*!
61  * \ingroup doxy_includes
62  * \defgroup doc_params_unpack_std doc_params_unpack_std
63  * \{
64 \param [in] buf Input message buffer.
65 \param bufSize Size of input buffer.
66 \param [out] pVal Pointer to value to unpack (set).
67 \param eEndian Unpacking order. See \ref NMEndian_T.
68  * \}
69  */
70 
71 /*!
72  * \ingroup doxy_includes
73  * \defgroup doc_params_unpack_fdef doc_params_unpack_fdef
74  * \{
75 \param pFieldDef Pointer to message field definition.
76 \param [in] buf Input message buffer.
77 \param bufSize Size of input buffer.
78 \param [out] pVal Pointer to value to unpack (set).
79 \param eEndian Unpacking order. See \ref NMEndian_T.
80 \param pCtl Internal control.
81  * \}
82  */
83 
84 /*!
85  * \ingroup doxy_includes
86  * \defgroup doc_return_unpack_std doc_return_unpack_std
87  * \{
88 \return
89 On success, returns the number of bytes unpacked.
90 On error, the appropriate negated
91 \ref man_libnetmsgs_ecodes "netmsgs error code" (\h_lt 0) is returned.
92  * \}
93  */
94 
95 /*! \} end of doxy_includes */