Commit 77dbeccf authored by Pekka Pessi's avatar Pekka Pessi
Browse files

Added Doxygen entries for SIPTAG_*_REF.

darcs-hash:20051110162748-65a35-8819d3cb46ac4789b5b56613699b631c505ee376.gz
parent 84c3f99c
......@@ -156,19 +156,28 @@ SIP_DLL extern tag_typedef_t siptag_header_str_ref;
/**@ingroup sip_#xxxxxx#
*
* Tag list item for pointer to a #xxxxxxx_xxxxxxx# object.
* Tag list item for pointer to a #xxxxxxx_xxxxxxx# structure.
*
* The SIPTAG_#XXXXXX#() macro is used to include a tag item with a
* pointer to a #sip_#xxxxxx#_t object in a tag list.
*
* @param x pointer to a #sip_#xxxxxx#_t header structure, or NULL.
*
* The corresponding tag taking reference parameter is
* SIPTAG_#XXXXXX#_REF().
*
* @HIDE
*/
#define SIPTAG_#XXXXXX#(x) siptag_#xxxxxx#, siptag_#xxxxxx#_v(x)
SIP_DLL extern tag_typedef_t siptag_#xxxxxx#;
/**@ingroup sip_#xxxxxx#
* Tag list item for reference to a a #xxxxxxx_xxxxxxx# pointer.
*/
#define SIPTAG_#XXXXXX#_REF(x) siptag_#xxxxxx#_ref, siptag_#xxxxxx#_vr(&(x))
SIP_DLL extern tag_typedef_t siptag_#xxxxxx#_ref;
/**@ingroup sip_#xxxxxx#
*
* Tag list item for string with #xxxxxxx_xxxxxxx# value.
......@@ -178,19 +187,22 @@ SIP_DLL extern tag_typedef_t siptag_#xxxxxx#;
*
* @param s pointer to a string containing sip_#xxxxxx#_t value, or NULL.
*
* The SIPTAG_#XXXXXX#_STR string can be converted to a
* The string in SIPTAG_#XXXXXX#_STR() can be converted to a
* sip_#xxxxxx#_t header structure by giving the string @a s has
* second argument to function sip_#xxxxxx#_make().
*
* The corresponding tag taking reference parameter is
* SIPTAG_#XXXXXX#_STR_REF().
*
* @HIDE
*/
#define SIPTAG_#XXXXXX#_STR(s) siptag_#xxxxxx#_str, tag_str_v(s)
SIP_DLL extern tag_typedef_t siptag_#xxxxxx#_str;
#define SIPTAG_#XXXXXX#_REF(x) siptag_#xxxxxx#_ref, siptag_#xxxxxx#_vr(&(x))
SIP_DLL extern tag_typedef_t siptag_#xxxxxx#_ref;
/**@ingroup sip_#xxxxxx#
* Tag list item for reference to a a #xxxxxxx_xxxxxxx# string.
*/
#define SIPTAG_#XXXXXX#_STR_REF(x) siptag_#xxxxxx#_str_ref, tag_str_vr(&(x))
SIP_DLL extern tag_typedef_t siptag_#xxxxxx#_str_ref;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment