Skip to content
This repository has been archived by the owner on Nov 17, 2020. It is now read-only.

Commit

Permalink
g-ir-doc-tool: Fix names of xref links
Browse files Browse the repository at this point in the history
  • Loading branch information
tomeuv committed Feb 20, 2012
1 parent 8c7e27b commit 9748408
Show file tree
Hide file tree
Showing 309 changed files with 448 additions and 444 deletions.
6 changes: 5 additions & 1 deletion giscanner/mallardwriter.py
Expand Up @@ -69,14 +69,18 @@ def format_inline(self, para):
if type_name in self._namespace.ctypes:
type_ = self._namespace.get_by_ctype(type_name)
xref = '%s.%s-%s' % (self._namespace.name, type_.name, signal_name)
xref_name = '%s.%s::%s' % (self._namespace.name, type_.name, signal_name)
else:
xref = link
xref_name = link
elif link in self._namespace.ctypes:
type_ = self._namespace.get_by_ctype(link)
xref = '%s.%s' % (self._namespace.name, type_.name)
xref_name = xref
else:
xref = link
result += '<link xref="%s">%s</link>' % (xref, link)
xref_name = link
result += '<link xref="%s">%s</link>' % (xref, xref_name)
if len(link) < len(rest):
result += self.format_inline(rest[len(link):])

Expand Down
Expand Up @@ -7,5 +7,5 @@
<info>
</info>
<title>GIRepository.ArrayType</title>
<p>The type of array in a <link xref="GIRepository.TypeInfo">GITypeInfo</link>.</p>
<p>The type of array in a <link xref="GIRepository.TypeInfo">GIRepository.TypeInfo</link>.</p>
</page>
Expand Up @@ -9,5 +9,5 @@
</info>
<title>GIRepositoryAttributeIter</title>
<p>An opaque structure used to iterate over attributes
in a <link xref="GIRepository.BaseInfo">GIBaseInfo</link> struct.</p>
in a <link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link> struct.</p>
</page>
Expand Up @@ -23,14 +23,14 @@
<synopsis><code mime="text/x-csrc">
gboolean g_base_info_equal (GIBaseInfo* info2);
</code></synopsis>
<p>Compare two <link xref="GIRepository.BaseInfo">GIBaseInfo</link>.</p><p>Using pointer comparison is not practical since many functions return
different instances of <link xref="GIRepository.BaseInfo">GIBaseInfo</link> that refers to the same part of the
TypeLib; use this function instead to do <link xref="GIRepository.BaseInfo">GIBaseInfo</link> comparisons.</p>
<p>Compare two <link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link>.</p><p>Using pointer comparison is not practical since many functions return
different instances of <link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link> that refers to the same part of the
TypeLib; use this function instead to do <link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link> comparisons.</p>

<table>
<tr>
<td><p>info2 :</p></td>
<td><p>a <link xref="GIRepository.BaseInfo">GIBaseInfo</link></p></td>
<td><p>a <link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down
Expand Up @@ -20,8 +20,8 @@
GIBaseInfo* g_base_info_get_container (void);
</code></synopsis>
<p>Obtain the container of the @info. The container is the parent
GIBaseInfo. For instance, the parent of a <link xref="GIRepository.FunctionInfo">GIFunctionInfo</link> is an
<link xref="GIRepository.ObjectInfo">GIObjectInfo</link> or <link xref="GIRepository.InterfaceInfo">GIInterfaceInfo</link>.</p>
GIBaseInfo. For instance, the parent of a <link xref="GIRepository.FunctionInfo">GIRepository.FunctionInfo</link> is an
<link xref="GIRepository.ObjectInfo">GIRepository.ObjectInfo</link> or <link xref="GIRepository.InterfaceInfo">GIRepository.InterfaceInfo</link>.</p>

<table>
<tr>
Expand Down
Expand Up @@ -20,7 +20,7 @@
gchar* g_base_info_get_name (void);
</code></synopsis>
<p>Obtain the name of the @info. What the name represents depends on
the <link xref="GIRepository.InfoType">GIInfoType</link> of the @info. For instance for <link xref="GIRepository.FunctionInfo">GIFunctionInfo</link> it is
the <link xref="GIRepository.InfoType">GIRepository.InfoType</link> of the @info. For instance for <link xref="GIRepository.FunctionInfo">GIRepository.FunctionInfo</link> it is
the name of the function.</p>

<table>
Expand Down
Expand Up @@ -56,7 +56,7 @@ g_print ("attribute name: %s value: %s", name, value);
<table>
<tr>
<td><p>iterator :</p></td>
<td><p>a <link xref="GIRepository.AttributeIter">GIAttributeIter</link> structure, must be initialized; see below</p></td>
<td><p>a <link xref="GIRepository.AttributeIter">GIRepository.AttributeIter</link> structure, must be initialized; see below</p></td>
</tr>
<tr>
<td><p>name :</p></td>
Expand Down
Expand Up @@ -9,16 +9,16 @@
</info>
<title>GIRepositoryBaseInfo</title>
<p>GIBaseInfo is the common base struct of all other *Info structs
accessible through the <link xref="GIRepository.Repository">GIRepository</link> API.
All other structs can be casted to a <link xref="GIRepository.BaseInfo">GIBaseInfo</link>, for instance:
accessible through the <link xref="GIRepository.Repository">GIRepository.Repository</link> API.
All other structs can be casted to a <link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link>, for instance:
&lt;example&gt;
&lt;title&gt;Casting a <link xref="GIRepository.FunctionInfo">GIFunctionInfo</link> to <link xref="GIRepository.BaseInfo">GIBaseInfo</link>&lt;/title&gt;
&lt;title&gt;Casting a <link xref="GIRepository.FunctionInfo">GIRepository.FunctionInfo</link> to <link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link>&lt;/title&gt;
&lt;programlisting&gt;
GIFunctionInfo *function_info = ...;
GIBaseInfo *info = (GIBaseInfo*)function_info;
&lt;/programlisting&gt;
&lt;/example&gt;
Most <link xref="GIRepository.Repository">GIRepository</link> APIs returning a <link xref="GIRepository.BaseInfo">GIBaseInfo</link> is actually creating a new struct, in other
Most <link xref="GIRepository.Repository">GIRepository.Repository</link> APIs returning a <link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link> is actually creating a new struct, in other
words, g_base_info_unref() has to be called when done accessing the data.
GIBaseInfos are normally accessed by calling either
g_irepository_find_by_name(), g_irepository_find_by_gtype() or g_irepository_get_info().</p><p>&lt;example&gt;
Expand Down
Expand Up @@ -7,6 +7,6 @@
<info>
</info>
<title>GIRepository.CallableInfo</title>
<p>Represents a callable, either <link xref="GIRepository.FunctionInfo">GIFunctionInfo</link>, <link xref="GIRepository.CallbackInfo">GICallbackInfo</link> or
<link xref="GIRepository.VFuncInfo">GIVFuncInfo</link>.</p>
<p>Represents a callable, either <link xref="GIRepository.FunctionInfo">GIRepository.FunctionInfo</link>, <link xref="GIRepository.CallbackInfo">GIRepository.CallbackInfo</link> or
<link xref="GIRepository.VFuncInfo">GIRepository.VFuncInfo</link>.</p>
</page>
Expand Up @@ -7,5 +7,5 @@
<info>
</info>
<title>GIRepository.Direction</title>
<p>The direction of a <link xref="GIRepository.ArgInfo">GIArgInfo</link>.</p>
<p>The direction of a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link>.</p>
</page>
Expand Up @@ -7,5 +7,5 @@
<info>
</info>
<title>GIRepository.FieldInfo</title>
<p>Represents a field of a <link xref="GIRepository.StructInfo">GIStructInfo</link> or a <link xref="GIRepository.UnionInfo">GIUnionInfo</link>.</p>
<p>Represents a field of a <link xref="GIRepository.StructInfo">GIRepository.StructInfo</link> or a <link xref="GIRepository.UnionInfo">GIRepository.UnionInfo</link>.</p>
</page>
Expand Up @@ -7,5 +7,5 @@
<info>
</info>
<title>GIRepository.FieldInfoFlags</title>
<p>Flags for a <link xref="GIRepository.FieldInfo">GIFieldInfo</link>.</p>
<p>Flags for a <link xref="GIRepository.FieldInfo">GIRepository.FieldInfo</link>.</p>
</page>
Expand Up @@ -7,5 +7,5 @@
<info>
</info>
<title>GIRepository.FunctionInfoFlags</title>
<p>Flags for a <link xref="GIRepository.FunctionInfo">GIFunctionInfo</link> struct.</p>
<p>Flags for a <link xref="GIRepository.FunctionInfo">GIRepository.FunctionInfo</link> struct.</p>
</page>
Expand Up @@ -7,5 +7,5 @@
<info>
</info>
<title>GIRepository.PropertyInfo</title>
<p>Represents a property of a <link xref="GIRepository.ObjectInfo">GIObjectInfo</link> or a <link xref="GIRepository.InterfaceInfo">GIInterfaceInfo</link>.</p>
<p>Represents a property of a <link xref="GIRepository.ObjectInfo">GIRepository.ObjectInfo</link> or a <link xref="GIRepository.InterfaceInfo">GIRepository.InterfaceInfo</link>.</p>
</page>
Expand Up @@ -40,7 +40,7 @@ otherwise ensure the namespace has already been loaded.</p><p>enum type, or %NUL
</tr>
<tr>
<td><p>Returns :</p></td>
<td><p><link xref="GIRepository.EnumInfo">GIEnumInfo</link> representing metadata about @domain's</p></td>
<td><p><link xref="GIRepository.EnumInfo">GIRepository.EnumInfo</link> representing metadata about @domain's</p></td>
</tr>
</table>
<p>Since 1.29.17</p>
Expand Down
Expand Up @@ -42,7 +42,7 @@ when you know the GType to originate from be from a loaded namespace.</p>
</tr>
<tr>
<td><p>Returns :</p></td>
<td><p><link xref="GIRepository.BaseInfo">GIBaseInfo</link> representing metadata about @type, or %NULL</p></td>
<td><p><link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link> representing metadata about @type, or %NULL</p></td>
</tr>
</table>
</page>
Expand Up @@ -49,7 +49,7 @@ ensure the namespace has already been loaded.</p>
</tr>
<tr>
<td><p>Returns :</p></td>
<td><p><link xref="GIRepository.BaseInfo">GIBaseInfo</link> representing metadata about @name, or %NULL</p></td>
<td><p><link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link> representing metadata about @name, or %NULL</p></td>
</tr>
</table>
</page>
Expand Up @@ -19,20 +19,20 @@
<synopsis><code mime="text/x-csrc">
GIRepository* g_irepository_get_default (void);
</code></synopsis>
<p>Returns the singleton process-global default <link xref="GIRepository.Repository">GIRepository</link>. It is
<p>Returns the singleton process-global default <link xref="GIRepository.Repository">GIRepository.Repository</link>. It is
not currently supported to have multiple repositories in a
particular process, but this function is provided in the unlikely
eventuality that it would become possible, and as a convenience for
higher level language bindings to conform to the GObject method
call conventions.
All methods on <link xref="GIRepository.Repository">GIRepository</link> also accept %NULL as an instance
All methods on <link xref="GIRepository.Repository">GIRepository.Repository</link> also accept %NULL as an instance
parameter to mean this default repository, which is usually more
convenient for C.</p>

<table>
<tr>
<td><p>Returns :</p></td>
<td><p>The global singleton <link xref="GIRepository.Repository">GIRepository</link></p></td>
<td><p>The global singleton <link xref="GIRepository.Repository">GIRepository.Repository</link></p></td>
</tr>
</table>
</page>
Expand Up @@ -50,7 +50,7 @@ entries.</p>
</tr>
<tr>
<td><p>Returns :</p></td>
<td><p><link xref="GIRepository.BaseInfo">GIBaseInfo</link> containing metadata</p></td>
<td><p><link xref="GIRepository.BaseInfo">GIRepository.BaseInfo</link> containing metadata</p></td>
</tr>
</table>
</page>
Expand Up @@ -59,7 +59,7 @@ not specified, the latest will be used.</p>
</tr>
<tr>
<td><p>Returns :</p></td>
<td><p>a pointer to the <link xref="GIRepository.Typelib">GITypelib</link> if successful, %NULL otherwise</p></td>
<td><p>a pointer to the <link xref="GIRepository.Typelib">GIRepository.Typelib</link> if successful, %NULL otherwise</p></td>
</tr>
</table>
</page>
Expand Up @@ -68,7 +68,7 @@ not specified, the latest will be used.</p>
</tr>
<tr>
<td><p>Returns :</p></td>
<td><p>a pointer to the <link xref="GIRepository.Typelib">GITypelib</link> if successful, %NULL otherwise</p></td>
<td><p>a pointer to the <link xref="GIRepository.Typelib">GIRepository.Typelib</link> if successful, %NULL otherwise</p></td>
</tr>
</table>
</page>
Expand Up @@ -7,7 +7,7 @@
<info>
</info>
<title>GIRepository.ScopeType</title>
<p>Scope type of a <link xref="GIRepository.ArgInfo">GIArgInfo</link> representing callback, determines how the
<p>Scope type of a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link> representing callback, determines how the
callback is invoked and is used to decided when the invoke structs
can be freed.</p>
</page>
Expand Up @@ -11,7 +11,7 @@
the caller. The callee is either a function/method/signal or an
object/interface where a property is defined. The caller is the side
accessing a property or calling a function.
<link xref="GIRepository.Transfer">GITransfer</link> specifies who's responsible for freeing the resources after the
<link xref="GIRepository.Transfer">GIRepository.Transfer</link> specifies who's responsible for freeing the resources after the
ownership transfer is complete. In case of a containing type such as a list,
an array or a hash table the container itself is specified differently from
the items within the container itself. Each container is freed differently,
Expand Down
Expand Up @@ -7,5 +7,5 @@
<info>
</info>
<title>GIRepository.TypeTag</title>
<p>The type tag of a <link xref="GIRepository.TypeInfo">GITypeInfo</link>.</p>
<p>The type tag of a <link xref="GIRepository.TypeInfo">GIRepository.TypeInfo</link>.</p>
</page>
Expand Up @@ -7,5 +7,5 @@
<info>
</info>
<title>GIRepository.VFuncInfoFlags</title>
<p>Flags of a <link xref="GIRepository.VFuncInfo">GIVFuncInfo</link> struct.</p>
<p>Flags of a <link xref="GIRepository.VFuncInfo">GIRepository.VFuncInfo</link> struct.</p>
</page>
Expand Up @@ -7,5 +7,5 @@
<info>
</info>
<title>GIRepository.ValueInfo</title>
<p>Represents a enum value of a <link xref="GIRepository.EnumInfo">GIEnumInfo</link>.</p>
<p>Represents a enum value of a <link xref="GIRepository.EnumInfo">GIRepository.EnumInfo</link>.</p>
</page>
Expand Up @@ -29,7 +29,7 @@ for arguments which are callbacks.</p>
<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down
Expand Up @@ -29,7 +29,7 @@ for arguments which are callbacks.</p>
<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down
Expand Up @@ -23,13 +23,13 @@
<synopsis><code mime="text/x-csrc">
GIDirection g_arg_info_get_direction (GIArgInfo* info);
</code></synopsis>
<p>Obtain the direction of the argument. Check <link xref="GIRepository.Direction">GIDirection</link> for possible
<p>Obtain the direction of the argument. Check <link xref="GIRepository.Direction">GIRepository.Direction</link> for possible
direction values.</p>

<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down
Expand Up @@ -24,12 +24,12 @@
GITransfer g_arg_info_get_ownership_transfer (GIArgInfo* info);
</code></synopsis>
<p>Obtain the ownership transfer for this argument.
<link xref="GIRepository.Transfer">GITransfer</link> contains a list of possible values.</p>
<link xref="GIRepository.Transfer">GIRepository.Transfer</link> contains a list of possible values.</p>

<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down
Expand Up @@ -26,12 +26,12 @@ GIScopeType g_arg_info_get_scope (GIArgInfo* info);
<p>Obtain the scope type for this argument. The scope type explains
how a callback is going to be invoked, most importantly when
the resources required to invoke it can be freed.
<link xref="GIRepository.ScopeType">GIScopeType</link> contains a list of possible values.</p>
<link xref="GIRepository.ScopeType">GIRepository.ScopeType</link> contains a list of possible values.</p>

<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down
Expand Up @@ -28,11 +28,11 @@ GITypeInfo* g_arg_info_get_type (GIArgInfo* info);
<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
<td><p>the <link xref="GIRepository.ArgInfo">GIArgInfo</link>, free it with</p></td>
<td><p>the <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link>, free it with</p></td>
</tr>
</table>
</page>
Expand Up @@ -31,7 +31,7 @@ callee allocates; if this is %TRUE, then the caller must allocate.</p>
<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down
Expand Up @@ -28,7 +28,7 @@ gboolean g_arg_info_is_optional (GIArgInfo* info);
<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down
Expand Up @@ -29,7 +29,7 @@ parameter or a return value.</p>
<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down
Expand Up @@ -28,7 +28,7 @@ gboolean g_arg_info_is_skip (GIArgInfo* info);
<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down
Expand Up @@ -35,7 +35,7 @@ allocation.</p><p>The initialized @type must not be referenced after @info is de
<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>type :</p></td>
Expand Down
Expand Up @@ -28,7 +28,7 @@ gboolean g_arg_info_may_be_null (GIArgInfo* info);
<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIArgInfo</link></p></td>
<td><p>a <link xref="GIRepository.ArgInfo">GIRepository.ArgInfo</link></p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
Expand Down

0 comments on commit 9748408

Please sign in to comment.