/**
* SECTION:tester
* @short_description: module for gtk-doc unit test
* @stability: stable
*
* This file contains non-sense code for the sole purpose of testing the docs.
*/
SECTION:testershort_descriptionmodule for gtk-doc unit teststabilitystableThis file contains non-sense code for the sole purpose of testing the docs.
/**
* annotation_array_length:
* @list: a #GtkListStore
* @n_columns: number of columns
* @types: (array length=n_columns): list of types
*
* Document parameter relation for array length.
*/
annotation_array_lengthlista #GtkListStoren_columnsnumber of columnstypesarraylist of typesDocument parameter relation for array length.
/**
* annotation_allow_none:
* @uri: a uri
* @label: (allow-none): an optional string, which is used in ways too
* complicated to describe in a single line, making it necessary to wrap it
*
* Document optional parameters.
*
* Returns: (transfer full) (allow-none): Returns stuff which you have to
* free after use, whose description is also rather long
*/
annotation_allow_noneuria urilabelallow-nonean optional string, which is used in ways too
complicated to describe in a single line, making it necessary to wrap itDocument optional parameters.returnstransferallow-noneReturns stuff which you have to
free after use, whose description is also rather long
/**
* annotation_nullable:
* @uri: a uri
* @label: (nullable): an optional string, which is used in ways too
* complicated to describe in a single line, making it necessary to wrap it
*
* Document optional parameters.
*
* Returns: (transfer full) (nullable): Returns stuff which you have to
* free after use, whose description is also rather long
*/
annotation_nullableuria urilabelnullablean optional string, which is used in ways too
complicated to describe in a single line, making it necessary to wrap itDocument optional parameters.returnstransfernullableReturns stuff which you have to
free after use, whose description is also rather long
/**
* annotation_elementtype:
* @list: (element-type GObject): list of #GObject instances to search
*
* Document optional parameters.
*
* Returns: %TRUE for success
*/
annotation_elementtypelistelement-typelist of #GObject instances to searchDocument optional parameters.returns%TRUE for success
/**
* annotation_elementtype_transfer:
* @list: (element-type utf8) (transfer full): list of #GObject instances to search
*
* Document optional parameters.
*
* Returns: %TRUE for success
*/
annotation_elementtype_transferlistelement-typetransferlist of #GObject instances to searchDocument optional parameters.returns%TRUE for success
/**
* annotation_elementtype_returns:
*
* Document optional parameters.
*
* Returns: (element-type GObject): A list of #GObject instances.
*/
annotation_elementtype_returnsDocument optional parameters.returnselement-typeA list of #GObject instances.
/**
* annotation_outparams:
* @list: (out) (transfer none): a pointer to take a list
*
* Document optional parameters.
*
* Returns: %TRUE for success
*/
annotation_outparamslistouttransfera pointer to take a listDocument optional parameters.returns%TRUE for success
/**
* annotation_outparams_optional:
* @list: (out) (transfer none) (optional): a pointer to take a list, or %NULL
*
* Document optional parameters.
*
* Returns: %TRUE for success
*/
annotation_outparams_optionallistouttransferoptionala pointer to take a list, or %NULLDocument optional parameters.returns%TRUE for success
/**
* annotation_outparams_nullable:
* @list: (out) (transfer none) (nullable): a pointer to take a list; but %NULL
* may also be returned
*
* Document optional parameters.
*
* Returns: %TRUE for success
*/
annotation_outparams_nullablelistouttransfernullablea pointer to take a list; but %NULL
may also be returnedDocument optional parameters.returns%TRUE for success
/**
* annotation_outparams_optional_nullable:
* @list: (out) (transfer none) (optional) (nullable): a pointer to take a
* list, or %NULL; but %NULL may also be returned in @list — isn’t that cool?
*
* Document optional parameters.
*
* Returns: %TRUE for success
*/
annotation_outparams_optional_nullablelistouttransferoptionalnullablea pointer to take a
list, or %NULL; but %NULL may also be returned in @list — isn’t that cool?Document optional parameters.returns%TRUE for success
/**
* annotation_skip: (skip)
* @list: a pointer to take a list
*
* Documentation for this function.
*/
annotation_skipskiplista pointer to take a listDocumentation for this function.
/**
* annotation_skip_return: (skip)
* @list: a pointer to take a list
*
* Documentation for this function.
*
* Returns: (skip): %TRUE for success
*/
annotation_skip_returnskiplista pointer to take a listDocumentation for this function.returnsskip%TRUE for success
/**
* annotation_scope:
* @callback: (scope async): a callback
* @user_data: data to pass to callback
*
* Documentation for this function.
*/
annotation_scopecallbackscopea callbackuser_datadata to pass to callbackDocumentation for this function.
/**
* annotation_rename_to: (rename-to annotation_scope)
*
* Documentation for this function.
*/
annotation_rename_torename-toDocumentation for this function.
/**
* stability_unstable:
*
* An experimental function.
*
* Stability: unstable
*/
stability_unstableAn experimental function.stabilityUnstable
/**
* annotation_multiline_on_function: (rename-to annotation_scope)
* (skip)
*
* Documentation for this function.
*/
annotation_multiline_on_functionrename-toskipDocumentation for this function.
/**
* annotation_multiline_on_function2:
* (rename-to annotation_scope)(skip)
*
* Documentation for this function.
*/
annotation_multiline_on_function2rename-toskipDocumentation for this function.