/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* one line.
* @par2: description of parameter 2
* @...: a %NULL-terminated list of bars
*
* The function description goes here. You can use @par1 to refer to parameters
* so that they are highlighted in the output. You can also use %constant
* for constants, function_name2() for functions and #GtkWidget for links to
* other declarations (which may be documented elsewhere).
*
* Returns: an integer.
*
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
function_namepar1description of parameter 1. These can extend over more than
one line.par2description of parameter 2...a %NULL-terminated list of barsThe function description goes here. You can use @par1 to refer to parameters
so that they are highlighted in the output. You can also use %constant
for constants, function_name2() for functions and #GtkWidget for links to
other declarations (which may be documented elsewhere).returnsan integer.since2.2deprecated2.18Use other_function() instead.
/**
* DBG:
* @fmt: format string
* @arg...: list of arguments
*
* Simple macro around btd_debug() which also include the function
* name it is called in.
*/
DBGfmtformat string...list of argumentsSimple macro around btd_debug() which also include the function
name it is called in.4: Warning: Test: "@arg..." parameter is deprecated, please use "@..." instead:
* @arg...: list of arguments
^
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* one line.
* @par2: description of parameter 2
* @Varargs: a %NULL-terminated list of bars
*
* The function description goes here. You can use @par1 to refer to parameters
* so that they are highlighted in the output. You can also use %constant
* for constants, function_name2() for functions and #GtkWidget for links to
* other declarations (which may be documented elsewhere).
*
* Returns: an integer.
*
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
function_namepar1description of parameter 1. These can extend over more than
one line.par2description of parameter 2...a %NULL-terminated list of barsThe function description goes here. You can use @par1 to refer to parameters
so that they are highlighted in the output. You can also use %constant
for constants, function_name2() for functions and #GtkWidget for links to
other declarations (which may be documented elsewhere).returnsan integer.since2.2deprecated2.18Use other_function() instead.6: Warning: Test: "@Varargs" parameter is deprecated, please use "@..." instead:
* @Varargs: a %NULL-terminated list of bars
^
/**
* function_name:
* @par1: description of parameter 1. These can extend over more than
* one line.
* @par2: description of parameter 2
* @varargs: a %NULL-terminated list of bars
*
* The function description goes here. You can use @par1 to refer to parameters
* so that they are highlighted in the output. You can also use %constant
* for constants, function_name2() for functions and #GtkWidget for links to
* other declarations (which may be documented elsewhere).
*
* Returns: an integer.
*
* Since: 2.2
* Deprecated: 2.18: Use other_function() instead.
*/
function_namepar1description of parameter 1. These can extend over more than
one line.par2description of parameter 2varargsa %NULL-terminated list of barsThe function description goes here. You can use @par1 to refer to parameters
so that they are highlighted in the output. You can also use %constant
for constants, function_name2() for functions and #GtkWidget for links to
other declarations (which may be documented elsewhere).returnsan integer.since2.2deprecated2.18Use other_function() instead.