From 67d354dc97c107c490a555a5e9ff245dc0cae2cc Mon Sep 17 00:00:00 2001 From: Tomeu Vizoso Date: Mon, 20 Feb 2012 17:35:08 +0100 Subject: g-ir-doc-tool: Add some more stuff to Enum pages --- giscanner/mallard-Python-enum.tmpl | 23 +++++ giscanner/mallardwriter.py | 3 + .../GIRepository.ArrayType.page | 5 +- .../GIRepository.Direction.page | 5 +- .../GIRepository.InfoType.page | 5 +- .../GIRepository.RepositoryError.page | 5 +- .../GIRepository.ScopeType.page | 5 +- .../GIRepository.Transfer.page | 5 +- .../GIRepository.TypeTag.page | 5 +- .../GIRepository.nvokeError.page | 5 +- .../GIRepository.ArrayType.page | 27 +++++- .../GIRepository.Direction.page | 23 ++++- .../GIRepository.InfoType.page | 91 +++++++++++++++++++- .../GIRepository.RepositoryError.page | 25 +++++- .../GIRepository.ScopeType.page | 27 +++++- .../GIRepository.Transfer.page | 23 ++++- .../GIRepository.TypeTag.page | 99 +++++++++++++++++++++- .../GIRepository.nvokeError.page | 23 ++++- 18 files changed, 365 insertions(+), 39 deletions(-) create mode 100644 giscanner/mallard-Python-enum.tmpl diff --git a/giscanner/mallard-Python-enum.tmpl b/giscanner/mallard-Python-enum.tmpl new file mode 100644 index 00000000..fd6ca0fb --- /dev/null +++ b/giscanner/mallard-Python-enum.tmpl @@ -0,0 +1,23 @@ + + + + + + ${node.namespace.name}.${node.name} + ${formatter.format(node.doc)} +% if node.members: + +% for member, ix in zip(node.members, range(len(node.members))): + + + + +% endfor +

${node.name}.${member.name.upper()} :

${formatter.format(member.doc)}
+% endif + + diff --git a/giscanner/mallardwriter.py b/giscanner/mallardwriter.py index 87b6f55c..5fd97048 100644 --- a/giscanner/mallardwriter.py +++ b/giscanner/mallardwriter.py @@ -210,6 +210,9 @@ class MallardWriter(object): page_id = '%s.%s.%s' % (namespace.name, node.parent.name, node.name) else: page_id = '%s.%s' % (namespace.name, node.name) + elif isinstance(node, ast.Enum): + template_name = 'mallard-%s-enum.tmpl' % self._language + page_id = '%s.%s' % (namespace.name, node.name) elif isinstance(node, ast.Property) and node.parent is not None: template_name = 'mallard-%s-property.tmpl' % self._language page_id = '%s.%s-%s' % (namespace.name, node.parent.name, node.name) diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.ArrayType.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.ArrayType.page index 1a88368b..b169ec67 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.ArrayType.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.ArrayType.page @@ -1,10 +1,11 @@ + GIRepository.ArrayType

The type of array in a GIRepository.TypeInfo.

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Direction.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Direction.page index b010ba34..6378b774 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Direction.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Direction.page @@ -1,10 +1,11 @@ + GIRepository.Direction

The direction of a GIRepository.ArgInfo.

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.InfoType.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.InfoType.page index f9964f29..f447a0f8 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.InfoType.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.InfoType.page @@ -1,10 +1,11 @@ + GIRepository.InfoType

The type of a GIBaseInfo struct.

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.RepositoryError.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.RepositoryError.page index 3f996c90..81fbd70f 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.RepositoryError.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.RepositoryError.page @@ -1,10 +1,11 @@ + GIRepository.RepositoryError diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.ScopeType.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.ScopeType.page index 5f12828b..2d9360cc 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.ScopeType.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.ScopeType.page @@ -1,10 +1,11 @@ + GIRepository.ScopeType

Scope type of a GIRepository.ArgInfo representing callback, determines how the diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Transfer.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Transfer.page index 37319a50..86fbf348 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Transfer.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.Transfer.page @@ -1,10 +1,11 @@ + GIRepository.Transfer

The transfer is the exchange of data between two parts, from the callee to diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.TypeTag.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.TypeTag.page index 328d5fed..a2da1552 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.TypeTag.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.TypeTag.page @@ -1,10 +1,11 @@ + GIRepository.TypeTag

The type tag of a GIRepository.TypeInfo.

diff --git a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.nvokeError.page b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.nvokeError.page index 3b3fec40..269351b6 100644 --- a/tests/doctool/GIRepository-2.0-C-expected/GIRepository.nvokeError.page +++ b/tests/doctool/GIRepository-2.0-C-expected/GIRepository.nvokeError.page @@ -1,10 +1,11 @@ + GIRepository.nvokeError

An error occuring while invoking a function via diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.ArrayType.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.ArrayType.page index 1a88368b..77f9a655 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.ArrayType.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.ArrayType.page @@ -1,11 +1,32 @@ + GIRepository.ArrayType -

The type of array in a GIRepository.TypeInfo.

+

The type of array in a GIRepository.TypeInfo.

+ + + + + + + + + + + + + + + + + + +

ArrayType.C :

ArrayType.ARRAY :

ArrayType.PTR_ARRAY :

ArrayType.BYTE_ARRAY :

+ diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Direction.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Direction.page index b010ba34..564e316e 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Direction.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Direction.page @@ -1,11 +1,28 @@ + GIRepository.Direction -

The direction of a GIRepository.ArgInfo.

+

The direction of a GIRepository.ArgInfo.

+ + + + + + + + + + + + + + +

Direction.IN :

Direction.OUT :

Direction.INOUT :

+ diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.InfoType.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.InfoType.page index f9964f29..da205239 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.InfoType.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.InfoType.page @@ -1,11 +1,96 @@ + GIRepository.InfoType -

The type of a GIBaseInfo struct.

+

The type of a GIBaseInfo struct.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

InfoType.INVALID :

InfoType.FUNCTION :

InfoType.CALLBACK :

InfoType.STRUCT :

InfoType.BOXED :

InfoType.ENUM :

InfoType.FLAGS :

InfoType.OBJECT :

InfoType.INTERFACE :

InfoType.CONSTANT :

InfoType.INVALID_0 :

InfoType.UNION :

InfoType.VALUE :

InfoType.SIGNAL :

InfoType.VFUNC :

InfoType.PROPERTY :

InfoType.FIELD :

InfoType.ARG :

InfoType.TYPE :

InfoType.UNRESOLVED :

+ diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.RepositoryError.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.RepositoryError.page index 3f996c90..9b09d1b8 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.RepositoryError.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.RepositoryError.page @@ -1,11 +1,32 @@ + GIRepository.RepositoryError + + + + + + + + + + + + + + + + + + + +

RepositoryError.TYPELIB_NOT_FOUND :

RepositoryError.NAMESPACE_MISMATCH :

RepositoryError.NAMESPACE_VERSION_CONFLICT :

RepositoryError.LIBRARY_NOT_FOUND :

 diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.ScopeType.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.ScopeType.page index 5f12828b..6125e4b2 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.ScopeType.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.ScopeType.page @@ -1,13 +1,34 @@ + GIRepository.ScopeType -

Scope type of a GIRepository.ArgInfo representing callback, determines how the +

Scope type of a GIRepository.ArgInfo representing callback, determines how the callback is invoked and is used to decided when the invoke structs can be freed.

+ + + + + + + + + + + + + + + + + + +

ScopeType.INVALID :

ScopeType.CALL :

ScopeType.ASYNC :

ScopeType.NOTIFIED :

+ diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Transfer.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Transfer.page index 37319a50..3d392ab1 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Transfer.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Transfer.page @@ -1,13 +1,14 @@ + GIRepository.Transfer -

The transfer is the exchange of data between two parts, from the callee to +

The transfer is the exchange of data between two parts, from the callee to 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. @@ -17,4 +18,20 @@ an array or a hash table the container itself is specified differently from the items within the container itself. Each container is freed differently, check the documentation for the types themselves for information on how to free them.

+ + + + + + + + + + + + + + +

Transfer.NOTHING :

Transfer.CONTAINER :

Transfer.EVERYTHING :

+ diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.TypeTag.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.TypeTag.page index 328d5fed..91a86b65 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.TypeTag.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.TypeTag.page @@ -1,11 +1,104 @@ + GIRepository.TypeTag -

The type tag of a GIRepository.TypeInfo.

+

The type tag of a GIRepository.TypeInfo.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

TypeTag.VOID :

TypeTag.BOOLEAN :

TypeTag.INT8 :

TypeTag.UINT8 :

TypeTag.INT16 :

TypeTag.UINT16 :

TypeTag.INT32 :

TypeTag.UINT32 :

TypeTag.INT64 :

TypeTag.UINT64 :

TypeTag.FLOAT :

TypeTag.DOUBLE :

TypeTag.GTYPE :

TypeTag.UTF8 :

TypeTag.FILENAME :

TypeTag.ARRAY :

TypeTag.INTERFACE :

TypeTag.GLIST :

TypeTag.GSLIST :

TypeTag.GHASH :

TypeTag.ERROR :

TypeTag.UNICHAR :

+ diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.nvokeError.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.nvokeError.page index 3b3fec40..fe0c7327 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.nvokeError.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.nvokeError.page @@ -1,12 +1,29 @@ + GIRepository.nvokeError -

An error occuring while invoking a function via +

An error occuring while invoking a function via g_function_info_invoke().

+ + + + + + + + + + + + + + +

nvokeError.FAILED :

nvokeError.SYMBOL_NOT_FOUND :

nvokeError.ARGUMENT_MISMATCH :

+ -- cgit v1.2.1