luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-27 14:36:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix gtk-doc warnings and update version infos

Browse Source 
Move things around and rename things until gtk-doc is happy.

This also moves the "Since" annotations to the next stable releases and
adds version added info for g_callable_info_get_instance_ownership_transfer()
and g_struct_info_find_field().
This commit is contained in:
Christoph Reiter 2018-12-09 18:04:49 +01:00
parent 4b32b6e116
commit 722518e5bc
22 changed files with 55 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
giarginfo.c
View File

@ -41,7 +41,7 @@
* <refsect1 id="gi-giarginfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-giarginfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----GIArgInfo * +----GIArgInfo
* </synopsis> * </synopsis>
* </refsect1> * </refsect1>
@ -179,7 +179,7 @@ g_arg_info_may_be_null (GIArgInfo *info)
* Obtain if an argument is only useful in C. * Obtain if an argument is only useful in C.
* *
* Returns: %TRUE if argument is only useful in C. * Returns: %TRUE if argument is only useful in C.
* Since: 1.29.0 * Since: 1.30
*/ */
gboolean gboolean
g_arg_info_is_skip (GIArgInfo *info) g_arg_info_is_skip (GIArgInfo *info)

17
gibaseinfo.h
View File

@ -33,23 +33,6 @@
G_BEGIN_DECLS G_BEGIN_DECLS
/**
* GIBaseInfoStub:
*
* TODO
*/
struct _GIBaseInfoStub {
/* <private> */
gint32 dummy1;
gint32 dummy2;
gpointer dummy3;
gpointer dummy4;
gpointer dummy5;
guint32 dummy6;
guint32 dummy7;
gpointer padding[4];
};
/** /**
* GIAttributeIter: * GIAttributeIter:
* *

3
gicallableinfo.c
View File

@ -48,7 +48,7 @@
* <refsect1 id="gi-gicallableinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-gicallableinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----GICallableInfo * +----GICallableInfo
* +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link> * +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
* +----<link linkend="gi-GISignalInfo">GISignalInfo</link> * +----<link linkend="gi-GISignalInfo">GISignalInfo</link>
@ -297,6 +297,7 @@ g_callable_info_get_caller_owns (GICallableInfo *info)
* Obtains the ownership transfer for the instance argument. * Obtains the ownership transfer for the instance argument.
* #GITransfer contains a list of possible transfer values. * #GITransfer contains a list of possible transfer values.
* *
* Since: 1.42
* Returns: the transfer mode of the instance argument * Returns: the transfer mode of the instance argument
*/ */
GITransfer GITransfer

4
giconstantinfo.c
View File

@ -41,7 +41,7 @@
* <refsect1 id="gi-giconstantinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-giconstantinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----GIConstantInfo * +----GIConstantInfo
* </synopsis> * </synopsis>
* </refsect1> * </refsect1>
@ -78,7 +78,7 @@ g_constant_info_get_type (GIConstantInfo *info)
* *
* Free the value returned from g_constant_info_get_value(). * Free the value returned from g_constant_info_get_value().
* *
* Since: 1.30.1 * Since: 1.32
*/ */
void void
g_constant_info_free_value (GIConstantInfo *info, g_constant_info_free_value (GIConstantInfo *info,

8
gienuminfo.c
View File

@ -40,7 +40,7 @@
* <refsect1 id="gi-gienuminfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-gienuminfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link> * +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
* +----GIEnumInfo * +----GIEnumInfo
* </synopsis> * </synopsis>
@ -78,7 +78,7 @@ g_enum_info_get_n_values (GIEnumInfo *info)
* *
* Returns: (transfer none): the string form of the error domain associated * Returns: (transfer none): the string form of the error domain associated
* with this enum, or %NULL. * with this enum, or %NULL.
* Since: 1.29.17 * Since: 1.30
*/ */
const gchar * const gchar *
g_enum_info_get_error_domain (GIEnumInfo *info) g_enum_info_get_error_domain (GIEnumInfo *info)
@ -132,7 +132,7 @@ g_enum_info_get_value (GIEnumInfo *info,
* Obtain the number of methods that this enum type has. * Obtain the number of methods that this enum type has.
* *
* Returns: number of methods * Returns: number of methods
* Since: 1.29.17 * Since: 1.30
*/ */
gint gint
g_enum_info_get_n_methods (GIEnumInfo *info) g_enum_info_get_n_methods (GIEnumInfo *info)
@ -157,7 +157,7 @@ g_enum_info_get_n_methods (GIEnumInfo *info)
* *
* Returns: (transfer full): the #GIFunctionInfo. Free the struct by calling * Returns: (transfer full): the #GIFunctionInfo. Free the struct by calling
* g_base_info_unref() when done. * g_base_info_unref() when done.
* Since: 1.29.17 * Since: 1.30
*/ */
GIFunctionInfo * GIFunctionInfo *
g_enum_info_get_method (GIEnumInfo *info, g_enum_info_get_method (GIEnumInfo *info,

2
gifieldinfo.c
View File

@ -44,7 +44,7 @@
* <refsect1 id="gi-gifieldinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-gifieldinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----GIFieldInfo * +----GIFieldInfo
* </synopsis> * </synopsis>
* </refsect1> * </refsect1>

2
gifunctioninfo.c
View File

@ -45,7 +45,7 @@
* <refsect1 id="gi-gifunctioninfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-gifunctioninfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----<link linkend="gi-GICallableInfo">GICallableInfo</link> * +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
* +----GIFunctionInfo * +----GIFunctionInfo
* +----<link linkend="gi-GISignalInfo">GISignalInfo</link> * +----<link linkend="gi-GISignalInfo">GISignalInfo</link>

2
giinterfaceinfo.c
View File

@ -41,7 +41,7 @@
* <refsect1 id="gi-giinterfaceinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-giinterfaceinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link> * +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
* +----GIInterfaceInfo * +----GIInterfaceInfo
* </synopsis> * </synopsis>

2
giobjectinfo.c
View File

@ -42,7 +42,7 @@
* <refsect1 id="gi-giobjectinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-giobjectinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link> * +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
* +----GIObjectInfo * +----GIObjectInfo
* </synopsis> * </synopsis>

2
gipropertyinfo.c
View File

@ -39,7 +39,7 @@
* <refsect1 id="gi-gipropertyinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-gipropertyinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----GIPropertyInfo * +----GIPropertyInfo
* </synopsis> * </synopsis>
* </refsect1> * </refsect1>

2
giregisteredtypeinfo.c
View File

@ -47,7 +47,7 @@
* <refsect1 id="gi-giregisteredtypeinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-giregisteredtypeinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----GIRegisteredTypeInfo * +----GIRegisteredTypeInfo
* +----<link linkend="gi-GIEnumInfo">GIEnumInfo</link> * +----<link linkend="gi-GIEnumInfo">GIEnumInfo</link>
* +----<link linkend="gi-GIInterfaceInfo">GIInterfaceInfo</link> * +----<link linkend="gi-GIInterfaceInfo">GIInterfaceInfo</link>

4
girepository.c
View File

@ -220,7 +220,7 @@ g_irepository_prepend_search_path (const char *directory)
* g_irepository_get_search_path: * g_irepository_get_search_path:
* *
* Returns the current search path #GIRepository will use when loading * Returns the current search path #GIRepository will use when loading
* typelib files. The list is internal to #GIRespository and should not * typelib files. The list is internal to #GIRepository and should not
* be freed, nor should its string elements. * be freed, nor should its string elements.
* *
* Returns: (element-type filename) (transfer none): #GSList of strings * Returns: (element-type filename) (transfer none): #GSList of strings
@ -900,7 +900,7 @@ find_by_error_domain_foreach (gpointer key,
* *
* Returns: (transfer full): #GIEnumInfo representing metadata about @domain's * Returns: (transfer full): #GIEnumInfo representing metadata about @domain's
* enum type, or %NULL * enum type, or %NULL
* Since: 1.29.17 * Since: 1.30
*/ */
GIEnumInfo * GIEnumInfo *
g_irepository_find_by_error_domain (GIRepository *repository, g_irepository_find_by_error_domain (GIRepository *repository,

2
gisignalinfo.c
View File

@ -42,7 +42,7 @@
* <refsect1 id="gi-gisignalinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-gisignalinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----<link linkend="gi-GICallableInfo">GICallableInfo</link> * +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
* +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link> * +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
* +----GISignalInfo * +----GISignalInfo

3
gistructinfo.c
View File

@ -42,7 +42,7 @@
* <refsect1 id="gi-giobjectinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-giobjectinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link> * +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
* +----GIStructInfo * +----GIStructInfo
* </synopsis> * </synopsis>
@ -123,6 +123,7 @@ g_struct_info_get_field (GIStructInfo *info,
* *
* Obtain the type information for field named @name. * Obtain the type information for field named @name.
* *
* Since: 1.46
* Returns: (transfer full): the #GIFieldInfo or %NULL if not found, * Returns: (transfer full): the #GIFieldInfo or %NULL if not found,
* free it with g_base_info_unref() when done. * free it with g_base_info_unref() when done.
*/ */

2
gistructinfo.h
View File

@ -48,7 +48,7 @@ GI_AVAILABLE_IN_ALL
GIFieldInfo * g_struct_info_get_field (GIStructInfo *info, GIFieldInfo * g_struct_info_get_field (GIStructInfo *info,
gint n); gint n);
GI_AVAILABLE_IN_ALL GI_AVAILABLE_IN_1_46
GIFieldInfo * g_struct_info_find_field (GIStructInfo *info, GIFieldInfo * g_struct_info_find_field (GIStructInfo *info,
const gchar *name); const gchar *name);

2
gitypeinfo.c
View File

@ -46,7 +46,7 @@
* <refsect1 id="gi-gitypeinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-gitypeinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----GITypeInfo * +----GITypeInfo
* </synopsis> * </synopsis>
* </refsect1> * </refsect1>

4
gitypelib-internal.h
View File

@ -528,7 +528,7 @@ typedef struct {
* @constructor: The function acts as a constructor for the object it is * @constructor: The function acts as a constructor for the object it is
* contained in. * contained in.
* @wraps_vfunc: The function is a simple wrapper for a virtual function. * @wraps_vfunc: The function is a simple wrapper for a virtual function.
* @throws: (deprecated): This is now additionally stored in the #SignatureBlob. * @throws: This is now additionally stored in the #SignatureBlob. (deprecated)
* @index: Index of the property that this function is a setter or getter of * @index: Index of the property that this function is a setter or getter of
* in the array of properties of the containing interface, or index * in the array of properties of the containing interface, or index
* of the virtual function that this function wraps. * of the virtual function that this function wraps.
@ -996,7 +996,7 @@ typedef struct {
* virtual function. * virtual function.
* @class_closure: Set if this virtual function is the class closure of a * @class_closure: Set if this virtual function is the class closure of a
* signal. * signal.
* @throws: (deprecated): This is now additionally stored in the #SignatureBlob. * @throws: This is now additionally stored in the #SignatureBlob. (deprecated)
* @reserved: Reserved for future use. * @reserved: Reserved for future use.
* @signal: The index of the signal in the list of signals of the object or * @signal: The index of the signal in the list of signals of the object or
* interface to which this virtual function belongs. * interface to which this virtual function belongs.

2
gitypelib.c
View File

@ -2235,7 +2235,7 @@ static GSList *library_paths;
* path (ie. LD_LIBRARY_PATH and DT_RPATH in ELF systems). * path (ie. LD_LIBRARY_PATH and DT_RPATH in ELF systems).
* See the documentation of your dynamic linker for full details. * See the documentation of your dynamic linker for full details.
* *
* Since: 1.35.8 * Since: 1.36
*/ */
void void
g_irepository_prepend_library_path (const char *directory) g_irepository_prepend_library_path (const char *directory)

18
gitypes.h
View File

@ -31,9 +31,17 @@
G_BEGIN_DECLS G_BEGIN_DECLS
#ifndef __GTK_DOC_IGNORE__ typedef struct _GIBaseInfoStub {
typedef struct _GIBaseInfoStub GIBaseInfo; /* <private> */
#endif gint32 dummy1;
gint32 dummy2;
gpointer dummy3;
gpointer dummy4;
gpointer dummy5;
guint32 dummy6;
guint32 dummy7;
gpointer padding[4];
} GIBaseInfo;
/** /**
* GICallableInfo: * GICallableInfo:
@ -60,7 +68,7 @@ typedef GIBaseInfo GIFunctionInfo;
* <refsect1 id="gi-gicallbackinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-gicallbackinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----<link linkend="gi-GICallableInfo">GICallableInfo</link> * +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
* +----GIFunctionInfo * +----GIFunctionInfo
* +----<link linkend="gi-GISignalInfo">GISignalInfo</link> * +----<link linkend="gi-GISignalInfo">GISignalInfo</link>
@ -135,7 +143,7 @@ typedef GIBaseInfo GIConstantInfo;
* <refsect1 id="gi-givalueinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-givalueinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----GIValueInfo * +----GIValueInfo
* </synopsis> * </synopsis>
* </refsect1> * </refsect1>

2
giunioninfo.c
View File

@ -42,7 +42,7 @@
* <refsect1 id="gi-giobjectinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-giobjectinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link> * +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
* +----GIUnionInfo * +----GIUnionInfo
* </synopsis> * </synopsis>

14
giversionmacros.h
View File

@ -139,4 +139,18 @@
# define GI_AVAILABLE_IN_1_44 _GI_EXTERN # define GI_AVAILABLE_IN_1_44 _GI_EXTERN
#endif #endif
#if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_46
# define GI_DEPRECATED_IN_1_46 GLIB_DEPRECATED
# define GI_DEPRECATED_IN_1_46_FOR(f) GLIB_DEPRECATED_FOR(f)
#else
# define GI_DEPRECATED_IN_1_46 _GI_EXTERN
# define GI_DEPRECATED_IN_1_46_FOR(f) _GI_EXTERN
#endif
#if GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_46
# define GI_AVAILABLE_IN_1_46 GLIB_UNAVAILABLE(2, 46)
#else
# define GI_AVAILABLE_IN_1_46 _GI_EXTERN
#endif
#endif /* __GIVERSIONMACROS_H__ */ #endif /* __GIVERSIONMACROS_H__ */

2
givfuncinfo.c
View File

@ -41,7 +41,7 @@
* <refsect1 id="gi-givfuncinfo.struct-hierarchy" role="struct_hierarchy"> * <refsect1 id="gi-givfuncinfo.struct-hierarchy" role="struct_hierarchy">
* <title role="struct_hierarchy.title">Struct hierarchy</title> * <title role="struct_hierarchy.title">Struct hierarchy</title>
* <synopsis> * <synopsis>
* <link linkend="gi-GIBaseInfo">GIBaseInfo</link> * <link linkend="GIBaseInfo">GIBaseInfo</link>
* +----<link linkend="gi-GICallableInfo">GICallableInfo</link> * +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
* +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link> * +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
* +----<link linkend="gi-GISignalInfo">GISignalInfo</link> * +----<link linkend="gi-GISignalInfo">GISignalInfo</link>