From 6b270e16dd8fb4a23b0a96115537a921aed4a4e1 Mon Sep 17 00:00:00 2001 From: "Jasper St. Pierre" Date: Thu, 31 Jan 2013 11:33:57 -0500 Subject: [PATCH] doctool: Use a standard title for both links and for page titles --- giscanner/doctemplates/C/mallard-C-class.tmpl | 2 +- giscanner/doctemplates/C/mallard-C-default.tmpl | 2 +- giscanner/doctemplates/C/mallard-C-enum.tmpl | 2 +- giscanner/doctemplates/C/mallard-C-function.tmpl | 2 +- giscanner/doctemplates/C/mallard-C-namespace.tmpl | 2 +- giscanner/doctemplates/C/mallard-C-property.tmpl | 2 +- giscanner/doctemplates/C/mallard-C-record.tmpl | 2 +- giscanner/doctemplates/C/mallard-C-signal.tmpl | 2 +- giscanner/doctemplates/C/mallard-C-vfunc.tmpl | 2 +- giscanner/doctemplates/Python/mallard-Python-class.tmpl | 2 +- giscanner/doctemplates/Python/mallard-Python-default.tmpl | 2 +- giscanner/doctemplates/Python/mallard-Python-enum.tmpl | 2 +- giscanner/doctemplates/Python/mallard-Python-function.tmpl | 2 +- giscanner/doctemplates/Python/mallard-Python-namespace.tmpl | 2 +- giscanner/doctemplates/Python/mallard-Python-property.tmpl | 2 +- giscanner/doctemplates/Python/mallard-Python-record.tmpl | 2 +- giscanner/doctemplates/Python/mallard-Python-signal.tmpl | 2 +- giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl | 2 +- .../DocExamples.Obj-property-example.page | 2 +- .../DocExamples.Obj-signal-example.page | 2 +- .../DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page | 2 +- tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page | 2 +- .../DocExamples-1.0-C-expected/DocExamples.ObjClass.page | 2 +- tests/doctool/DocExamples-1.0-C-expected/index.page | 2 +- .../DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page | 2 +- .../DocExamples-1.0-Python-expected/DocExamples.Obj.method.page | 2 +- .../DocExamples.Obj.static_method.page | 2 +- tests/doctool/DocExamples-1.0-Python-expected/index.page | 2 +- 28 files changed, 28 insertions(+), 28 deletions(-) diff --git a/giscanner/doctemplates/C/mallard-C-class.tmpl b/giscanner/doctemplates/C/mallard-C-class.tmpl index 5081f857..3a208447 100644 --- a/giscanner/doctemplates/C/mallard-C-class.tmpl +++ b/giscanner/doctemplates/C/mallard-C-class.tmpl @@ -8,7 +8,7 @@ - ${node.ctype} + ${formatter.format_page_name(node)} ${formatter.format(node, node.doc)} % if node.version:

Since ${node.version}

diff --git a/giscanner/doctemplates/C/mallard-C-default.tmpl b/giscanner/doctemplates/C/mallard-C-default.tmpl index c6ce1760..d2c41056 100644 --- a/giscanner/doctemplates/C/mallard-C-default.tmpl +++ b/giscanner/doctemplates/C/mallard-C-default.tmpl @@ -6,6 +6,6 @@ xmlns:ui="http://projectmallard.org/experimental/ui/"> - ${namespace.name}.${node.name} + ${formatter.format_page_name(node)} ${formatter.format(node, node.doc)} diff --git a/giscanner/doctemplates/C/mallard-C-enum.tmpl b/giscanner/doctemplates/C/mallard-C-enum.tmpl index 393fae4f..7283366d 100644 --- a/giscanner/doctemplates/C/mallard-C-enum.tmpl +++ b/giscanner/doctemplates/C/mallard-C-enum.tmpl @@ -7,6 +7,6 @@ - ${node.namespace.name}.${node.name} + ${formatter.format_page_name(node)} ${formatter.format(node, node.doc)} diff --git a/giscanner/doctemplates/C/mallard-C-function.tmpl b/giscanner/doctemplates/C/mallard-C-function.tmpl index 853a7619..d433aa56 100644 --- a/giscanner/doctemplates/C/mallard-C-function.tmpl +++ b/giscanner/doctemplates/C/mallard-C-function.tmpl @@ -34,7 +34,7 @@ % endfor - ${node.symbol} + ${formatter.format_page_name(node)} ${node.retval.type.ctype} ${node.symbol} (\ % if node.is_method: diff --git a/giscanner/doctemplates/C/mallard-C-namespace.tmpl b/giscanner/doctemplates/C/mallard-C-namespace.tmpl index 5d39dbcb..39d02619 100644 --- a/giscanner/doctemplates/C/mallard-C-namespace.tmpl +++ b/giscanner/doctemplates/C/mallard-C-namespace.tmpl @@ -6,7 +6,7 @@ xmlns:ui="http://projectmallard.org/experimental/ui/"> - ${node.name} Documentation + ${formatter.format_page_name(node)} Classes diff --git a/giscanner/doctemplates/C/mallard-C-property.tmpl b/giscanner/doctemplates/C/mallard-C-property.tmpl index 68f09ec8..a253160d 100644 --- a/giscanner/doctemplates/C/mallard-C-property.tmpl +++ b/giscanner/doctemplates/C/mallard-C-property.tmpl @@ -8,6 +8,6 @@ ${node.name} - ${node.parent.ctype}:${node.name} + ${formatter.format_page_name(node)} ${formatter.format(node, node.doc)} diff --git a/giscanner/doctemplates/C/mallard-C-record.tmpl b/giscanner/doctemplates/C/mallard-C-record.tmpl index f0c80dc0..7283366d 100644 --- a/giscanner/doctemplates/C/mallard-C-record.tmpl +++ b/giscanner/doctemplates/C/mallard-C-record.tmpl @@ -7,6 +7,6 @@ - ${node.namespace.name}${node.name} + ${formatter.format_page_name(node)} ${formatter.format(node, node.doc)} diff --git a/giscanner/doctemplates/C/mallard-C-signal.tmpl b/giscanner/doctemplates/C/mallard-C-signal.tmpl index 33ed5c2d..49ee9852 100644 --- a/giscanner/doctemplates/C/mallard-C-signal.tmpl +++ b/giscanner/doctemplates/C/mallard-C-signal.tmpl @@ -8,6 +8,6 @@ ${node.name} - ${node.parent.ctype}::${node.name} + ${formatter.format_page_name(node)} ${formatter.format(node, node.doc)} diff --git a/giscanner/doctemplates/C/mallard-C-vfunc.tmpl b/giscanner/doctemplates/C/mallard-C-vfunc.tmpl index 3a00d992..3363ea8c 100644 --- a/giscanner/doctemplates/C/mallard-C-vfunc.tmpl +++ b/giscanner/doctemplates/C/mallard-C-vfunc.tmpl @@ -8,7 +8,7 @@ - ${node.name} + ${formatter.format_page_name(node)} ${formatter.format(node, node.doc)} diff --git a/giscanner/doctemplates/Python/mallard-Python-class.tmpl b/giscanner/doctemplates/Python/mallard-Python-class.tmpl index 6eef692e..800d241f 100644 --- a/giscanner/doctemplates/Python/mallard-Python-class.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-class.tmpl @@ -8,7 +8,7 @@ - ${namespace.name}.${node.name} + ${formatter.format_page_name(node)} ${formatter.format(node, node.doc)} diff --git a/giscanner/doctemplates/Python/mallard-Python-default.tmpl b/giscanner/doctemplates/Python/mallard-Python-default.tmpl index 7bc55d8d..1d202109 100644 --- a/giscanner/doctemplates/Python/mallard-Python-default.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-default.tmpl @@ -6,6 +6,6 @@ xmlns:ui="http://projectmallard.org/experimental/ui/"> - ${namespace.name}.${node.name} + ${formatter.format_page_name(node)} ${formatter.format(node, node.doc)} diff --git a/giscanner/doctemplates/Python/mallard-Python-enum.tmpl b/giscanner/doctemplates/Python/mallard-Python-enum.tmpl index 55ebdf51..c1a4d8c5 100644 --- a/giscanner/doctemplates/Python/mallard-Python-enum.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-enum.tmpl @@ -7,7 +7,7 @@ - ${node.namespace.name}.${node.name} + ${formatter.format_page_name(node)} ${formatter.format(node, node.doc)} % if node.members: diff --git a/giscanner/doctemplates/Python/mallard-Python-function.tmpl b/giscanner/doctemplates/Python/mallard-Python-function.tmpl index 405f2c3c..1976a1ca 100644 --- a/giscanner/doctemplates/Python/mallard-Python-function.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-function.tmpl @@ -34,7 +34,7 @@ % endfor - ${node.name} + ${formatter.format_page_name(node)} % if len(node.parameters) != 0: @accepts(\ diff --git a/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl b/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl index 4ccf452e..97bd7132 100644 --- a/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl @@ -6,7 +6,7 @@ xmlns:ui="http://projectmallard.org/experimental/ui/"> - ${node.name} Documentation + ${formatter.format_page_name(node)} Classes diff --git a/giscanner/doctemplates/Python/mallard-Python-property.tmpl b/giscanner/doctemplates/Python/mallard-Python-property.tmpl index 47187a73..7f4138cd 100644 --- a/giscanner/doctemplates/Python/mallard-Python-property.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-property.tmpl @@ -8,7 +8,7 @@ ${node.name} - ${namespace.name}.${node.parent.name}:${node.name} + ${formatter.format_page_name(node)} "${node.name}" ${formatter.format_type(node.type)} : ${formatter.format_property_flags(node)} diff --git a/giscanner/doctemplates/Python/mallard-Python-record.tmpl b/giscanner/doctemplates/Python/mallard-Python-record.tmpl index f6abd116..43bea043 100644 --- a/giscanner/doctemplates/Python/mallard-Python-record.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-record.tmpl @@ -7,6 +7,6 @@ - ${node.namespace.name}${node.name} + ${formatter.format_page_name(node)}

${node.doc}

diff --git a/giscanner/doctemplates/Python/mallard-Python-signal.tmpl b/giscanner/doctemplates/Python/mallard-Python-signal.tmpl index 7bfaf9c5..8dda89be 100644 --- a/giscanner/doctemplates/Python/mallard-Python-signal.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-signal.tmpl @@ -8,7 +8,7 @@ ${node.name} - ${namespace.name}.${node.parent.name}::${node.name} + ${formatter.format_page_name(node)} def callback(${formatter.to_underscores(node.parent.name).lower()}, \ % for arg, ix in zip(node.parameters, range(len(node.parameters))): diff --git a/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl b/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl index 2437e56a..86dc685b 100644 --- a/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl @@ -9,7 +9,7 @@ ${node.name} - ${namespace.name}.${node.parent.name}.${node.name} + ${formatter.format_page_name(node)} % if len(node.parameters) != 0: @accepts(\ diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page index e7702a21..fde0ffb4 100644 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page +++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page @@ -8,6 +8,6 @@ property-example - DocExamplesObj:property-example + DocExamples.Obj:property-example

This is an example of how to document a property.

diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page index 548588c8..7f63fa40 100644 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page +++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page @@ -8,6 +8,6 @@ signal-example - DocExamplesObj::signal-example + DocExamples.Obj::signal-example

This is an example of how to document a signal.

diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page index 345d64b9..c9b47666 100644 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page +++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page @@ -8,7 +8,7 @@ - vfunc + DocExamples.Obj::vfunc

This is an example of how to document a vfunc.

diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page index 0a46bd23..6014906c 100644 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page +++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page @@ -8,7 +8,7 @@ - DocExamplesObj + DocExamples.Obj

This is an example of how to document a class

This class has a signal: DocExamples.Obj::signal-example.

And also has a property: DocExamples.Obj:property-example.

Since 0.99

diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page index c3a958d6..c8e43755 100644 --- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page +++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page @@ -7,6 +7,6 @@ - DocExamplesObjClass + DocExamples.ObjClass diff --git a/tests/doctool/DocExamples-1.0-C-expected/index.page b/tests/doctool/DocExamples-1.0-C-expected/index.page index a61ea759..c87a104b 100644 --- a/tests/doctool/DocExamples-1.0-C-expected/index.page +++ b/tests/doctool/DocExamples-1.0-C-expected/index.page @@ -6,7 +6,7 @@ xmlns:ui="http://projectmallard.org/experimental/ui/"> - DocExamples Documentation + Index Classes diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page index 4f56baed..8a02f616 100644 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page +++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page @@ -9,7 +9,7 @@ vfunc - DocExamples.Obj.vfunc + DocExamples.Obj::vfunc @accepts(int) @returns(none) diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page index 748add82..2477e451 100644 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page +++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page @@ -38,7 +38,7 @@ - method + Obj.method @accepts(int, float, bool, gpointer, unicode) @returns(bool) diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page index efbdc41a..e040414f 100644 --- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page +++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page @@ -18,7 +18,7 @@ - static_method + Obj.static_method @accepts(int) @returns(bool) diff --git a/tests/doctool/DocExamples-1.0-Python-expected/index.page b/tests/doctool/DocExamples-1.0-Python-expected/index.page index fc6a9b7d..bbf9d2d7 100644 --- a/tests/doctool/DocExamples-1.0-Python-expected/index.page +++ b/tests/doctool/DocExamples-1.0-Python-expected/index.page @@ -6,7 +6,7 @@ xmlns:ui="http://projectmallard.org/experimental/ui/"> - DocExamples Documentation + Index Classes -- 2.34.1