From d7df8237f78c2a2e70fd525ef9eb2fd0777a5a1d Mon Sep 17 00:00:00 2001 From: Tomeu Vizoso Date: Sun, 19 Feb 2012 11:06:35 +0100 Subject: g-ir-doc-tool: Display Returns: even if there's no args --- giscanner/mallard-C-function.tmpl | 2 +- giscanner/mallard-Python-function.tmpl | 2 +- .../GIRepository.BaseInfo.get_container.page | 6 ++++++ .../GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_name.page | 6 ++++++ .../GIRepository.BaseInfo.get_namespace.page | 6 ++++++ .../GIRepository.BaseInfo.get_typelib.page | 6 ++++++ .../GIRepository.BaseInfo.is_deprecated.page | 6 ++++++ .../GIRepository-2.0-C-expected/GIRepository.BaseInfo.ref.page | 6 ++++++ .../GIRepository-2.0-C-expected/GIRepository.BaseInfo.unref.page | 6 ++++++ .../GIRepository.Repository.error_quark.page | 6 ++++++ .../GIRepository.Repository.get_default.page | 6 ++++++ .../GIRepository.Repository.get_loaded_namespaces.page | 6 ++++++ .../GIRepository.Repository.get_option_group.page | 6 ++++++ .../GIRepository.Repository.get_search_path.page | 6 ++++++ .../GIRepository.invoke_error_quark.page | 6 ++++++ .../GIRepository.BaseInfo.get_container.page | 6 ++++++ .../GIRepository.BaseInfo.get_name.page | 6 ++++++ .../GIRepository.BaseInfo.get_namespace.page | 6 ++++++ .../GIRepository.BaseInfo.get_typelib.page | 6 ++++++ .../GIRepository.BaseInfo.is_deprecated.page | 6 ++++++ .../GIRepository-2.0-Python-expected/GIRepository.BaseInfo.ref.page | 6 ++++++ .../GIRepository.BaseInfo.unref.page | 6 ++++++ .../GIRepository.Repository.error_quark.page | 6 ++++++ .../GIRepository.Repository.get_default.page | 6 ++++++ .../GIRepository.Repository.get_loaded_namespaces.page | 6 ++++++ .../GIRepository.Repository.get_option_group.page | 6 ++++++ .../GIRepository.Repository.get_search_path.page | 6 ++++++ .../GIRepository.invoke_error_quark.page | 6 ++++++ 28 files changed, 158 insertions(+), 2 deletions(-) diff --git a/giscanner/mallard-C-function.tmpl b/giscanner/mallard-C-function.tmpl index 4eb3d07b..5cab7649 100644 --- a/giscanner/mallard-C-function.tmpl +++ b/giscanner/mallard-C-function.tmpl @@ -73,7 +73,7 @@ ${formatter.format_type(arg.type) | x} ${arg.argname}\ ${formatter.format(node.doc)} -% if node.parameters: +% if node.parameters or node.retval: % for arg, ix in zip(node.parameters, range(len(node.parameters))): diff --git a/giscanner/mallard-Python-function.tmpl b/giscanner/mallard-Python-function.tmpl index 2bca6ac6..ceddea62 100644 --- a/giscanner/mallard-Python-function.tmpl +++ b/giscanner/mallard-Python-function.tmpl @@ -69,7 +69,7 @@ ${arg.argname}\ ${formatter.format(node.doc)} -% if node.parameters: +% if node.parameters or node.retval:
% for arg, ix in zip(node.parameters, range(len(node.parameters))): diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_container.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_container.page index d4de981f..f8e8346c 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_container.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_container.page @@ -23,4 +23,10 @@ GIBaseInfo* g_base_info_get_container (void); GIBaseInfo. For instance, the parent of a GIFunctionInfo is an GIObjectInfo or GIInterfaceInfo.

+
+ + + + +

Returns :

the container

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_name.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_name.page index 00d1f32d..ad4115bf 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_name.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_name.page @@ -23,4 +23,10 @@ gchar* g_base_info_get_name (void); the GIInfoType of the @info. For instance for GIFunctionInfo it is the name of the function.

+ + + + + +

Returns :

the name of @info or %NULL if it lacks a name.

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_namespace.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_namespace.page index 77e07c14..352c66e2 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_namespace.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_namespace.page @@ -21,4 +21,10 @@ gchar* g_base_info_get_namespace (void);

Obtain the namespace of @info.

+ + + + + +

Returns :

the namespace

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_typelib.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_typelib.page index f0615c10..6c904dc1 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_typelib.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.get_typelib.page @@ -21,4 +21,10 @@ GITypelib* g_base_info_get_typelib (void);

Obtain the typelib this @info belongs to

+ + + + + +

Returns :

the typelib.

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.is_deprecated.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.is_deprecated.page index 2e928377..0cd6ff0f 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.is_deprecated.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.is_deprecated.page @@ -22,4 +22,10 @@ gboolean g_base_info_is_deprecated (void);

Obtain whether the @info is represents a metadata which is deprecated or not.

+ + + + + +

Returns :

%TRUE if deprecated

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.ref.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.ref.page index c9d09fc6..307b6225 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.ref.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.ref.page @@ -21,4 +21,10 @@ GIBaseInfo* g_base_info_ref (void);

Increases the reference count of @info.

+ + + + + +

Returns :

the same @info.

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.unref.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.unref.page index 5dfcfcf8..9a14d4ee 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.unref.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.BaseInfo.unref.page @@ -22,4 +22,10 @@ void g_base_info_unref (void);

Decreases the reference count of @info. When its reference count drops to 0, the info is freed.

+ + + + + +

Returns :

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.error_quark.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.error_quark.page index fd2c5633..b9534309 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.error_quark.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.error_quark.page @@ -21,4 +21,10 @@ GQuark g_irepository_error_quark (void); + + + + + +

Returns :

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_default.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_default.page index 348dd3f3..9d06bea5 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_default.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_default.page @@ -29,4 +29,10 @@ All methods on GIRepository also accept %NULL a parameter to mean this default repository, which is usually more convenient for C.

+ + + + + +

Returns :

The global singleton GIRepository

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_loaded_namespaces.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_loaded_namespaces.page index 6a2ddad6..b82afb75 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_loaded_namespaces.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_loaded_namespaces.page @@ -25,4 +25,10 @@ utf8* g_irepository_get_loaded_namespaces (GIRepository *self);

Return the list of currently loaded namespaces.

+ + + + + +

Returns :

List of namespaces

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_option_group.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_option_group.page index 3102c736..e3fac668 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_option_group.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_option_group.page @@ -23,4 +23,10 @@ GOptionGroup* g_irepository_get_option_group (void); by the dumper and for programs that wants to provide introspection information

+ + + + + +

Returns :

the option group

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_search_path.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_search_path.page index 1b9c11e9..6d3785fa 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_search_path.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Repository.get_search_path.page @@ -23,4 +23,10 @@ GSList* g_irepository_get_search_path (void); The string is internal to GIRespository and should not be freed, nor should the elements.

+ + + + + +

Returns :

list of strings

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.invoke_error_quark.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.invoke_error_quark.page index 2fb88f0e..d59baa93 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.invoke_error_quark.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.invoke_error_quark.page @@ -21,4 +21,10 @@ GQuark g_invoke_error_quark (void); + + + + + +

Returns :

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_container.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_container.page index 5a25317d..696cd4bb 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_container.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_container.page @@ -24,4 +24,10 @@ def GIRepository.BaseInfo.get_container() GIBaseInfo. For instance, the parent of a GIFunctionInfo is an GIObjectInfo or GIInterfaceInfo.

+ + + + + +

Returns :

the container

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_name.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_name.page index 7662bdd4..4201a10d 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_name.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_name.page @@ -24,4 +24,10 @@ def GIRepository.BaseInfo.get_name() the GIInfoType of the @info. For instance for GIFunctionInfo it is the name of the function.

+ + + + + +

Returns :

the name of @info or %NULL if it lacks a name.

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_namespace.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_namespace.page index 614ef9e1..3eb4b515 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_namespace.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_namespace.page @@ -22,4 +22,10 @@ def GIRepository.BaseInfo.get_namespace()

Obtain the namespace of @info.

+ + + + + +

Returns :

the namespace

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_typelib.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_typelib.page index ddc437fc..2463da0b 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_typelib.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.get_typelib.page @@ -22,4 +22,10 @@ def GIRepository.BaseInfo.get_typelib()

Obtain the typelib this @info belongs to

+ + + + + +

Returns :

the typelib.

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.is_deprecated.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.is_deprecated.page index 5de73b3d..5aca68b4 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.is_deprecated.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.is_deprecated.page @@ -23,4 +23,10 @@ def GIRepository.BaseInfo.is_deprecated()

Obtain whether the @info is represents a metadata which is deprecated or not.

+ + + + + +

Returns :

%TRUE if deprecated

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.ref.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.ref.page index c9142199..f04fc258 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.ref.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.ref.page @@ -22,4 +22,10 @@ def GIRepository.BaseInfo.ref()

Increases the reference count of @info.

+ + + + + +

Returns :

the same @info.

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.unref.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.unref.page index 73ba6908..afb4a988 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.unref.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.BaseInfo.unref.page @@ -23,4 +23,10 @@ def GIRepository.BaseInfo.unref()

Decreases the reference count of @info. When its reference count drops to 0, the info is freed.

+ + + + + +

Returns :

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.error_quark.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.error_quark.page index 57809458..a82ae391 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.error_quark.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.error_quark.page @@ -22,4 +22,10 @@ def GIRepository.Repository.error_quark() + + + + + +

Returns :

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_default.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_default.page index 5c69b948..9d6467d4 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_default.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_default.page @@ -30,4 +30,10 @@ All methods on GIRepository also accept %NULL a parameter to mean this default repository, which is usually more convenient for C.

+ + + + + +

Returns :

The global singleton GIRepository

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_loaded_namespaces.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_loaded_namespaces.page index ca239133..b1e3bedf 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_loaded_namespaces.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_loaded_namespaces.page @@ -26,4 +26,10 @@ def GIRepository.Repository.get_loaded_namespaces()

Return the list of currently loaded namespaces.

+ + + + + +

Returns :

List of namespaces

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_option_group.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_option_group.page index 10661a44..8ebd11ab 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_option_group.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_option_group.page @@ -24,4 +24,10 @@ def GIRepository.Repository.get_option_group() by the dumper and for programs that wants to provide introspection information

+ + + + + +

Returns :

the option group

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_search_path.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_search_path.page index 1d13add0..f0f1de28 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_search_path.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.get_search_path.page @@ -24,4 +24,10 @@ def GIRepository.Repository.get_search_path() The string is internal to GIRespository and should not be freed, nor should the elements.

+ + + + + +

Returns :

list of strings

diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.invoke_error_quark.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.invoke_error_quark.page index 7c594fcd..a1bea3d4 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.invoke_error_quark.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.invoke_error_quark.page @@ -22,4 +22,10 @@ def invoke_error_quark() + + + + + +

Returns :

-- cgit v1.2.1