summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJasper St. Pierre <jstpierre@mecheye.net>2013-01-31 11:33:57 -0500
committerJasper St. Pierre <jstpierre@mecheye.net>2013-02-01 19:47:41 -0500
commit6b270e16dd8fb4a23b0a96115537a921aed4a4e1 (patch)
tree9a635aa1311c53b9070eef268d85c37c76685dd1
parent9a029d510eac79c2e651ea8bffeea1b8a09d3d57 (diff)
downloadgobject-introspection-6b270e16dd8fb4a23b0a96115537a921aed4a4e1.tar.gz
doctool: Use a standard title for both links and for page titles
-rw-r--r--giscanner/doctemplates/C/mallard-C-class.tmpl2
-rw-r--r--giscanner/doctemplates/C/mallard-C-default.tmpl2
-rw-r--r--giscanner/doctemplates/C/mallard-C-enum.tmpl2
-rw-r--r--giscanner/doctemplates/C/mallard-C-function.tmpl2
-rw-r--r--giscanner/doctemplates/C/mallard-C-namespace.tmpl2
-rw-r--r--giscanner/doctemplates/C/mallard-C-property.tmpl2
-rw-r--r--giscanner/doctemplates/C/mallard-C-record.tmpl2
-rw-r--r--giscanner/doctemplates/C/mallard-C-signal.tmpl2
-rw-r--r--giscanner/doctemplates/C/mallard-C-vfunc.tmpl2
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-class.tmpl2
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-default.tmpl2
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-enum.tmpl2
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-function.tmpl2
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-namespace.tmpl2
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-property.tmpl2
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-record.tmpl2
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-signal.tmpl2
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl2
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page2
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page2
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page2
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page2
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page2
-rw-r--r--tests/doctool/DocExamples-1.0-C-expected/index.page2
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page2
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page2
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page2
-rw-r--r--tests/doctool/DocExamples-1.0-Python-expected/index.page2
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 @@
<info>
<link type="guide" xref="index" group="class"/>
</info>
- <title>${node.ctype}</title>
+ <title>${formatter.format_page_name(node)}</title>
${formatter.format(node, node.doc)}
% if node.version:
<p>Since ${node.version}</p>
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/">
<info>
</info>
- <title>${namespace.name}.${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
${formatter.format(node, node.doc)}
</page>
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 @@
<info>
<link type="guide" xref="index"/>
</info>
- <title>${node.namespace.name}.${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
${formatter.format(node, node.doc)}
</page>
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
</api:function>
</info>
- <title>${node.symbol}</title>
+ <title>${formatter.format_page_name(node)}</title>
<synopsis><code mime="text/x-csrc">
${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/">
<info>
</info>
- <title>${node.name} Documentation</title>
+ <title>${formatter.format_page_name(node)}</title>
<links type="topic" ui:expanded="yes" groups="class" style="linklist">
<title>Classes</title>
</links>
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 @@
<link type="guide" xref="${namespace.name}.${node.parent.name}" group="property"/>
<title type="link" role="topic">${node.name}</title>
</info>
- <title>${node.parent.ctype}:${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
${formatter.format(node, node.doc)}
</page>
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 @@
<info>
<link type="guide" xref="index"/>
</info>
- <title>${node.namespace.name}${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
${formatter.format(node, node.doc)}
</page>
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 @@
<link type="guide" xref="${namespace.name}.${node.parent.name}" group="signal"/>
<title type="link" role="topic">${node.name}</title>
</info>
- <title>${node.parent.ctype}::${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
${formatter.format(node, node.doc)}
</page>
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 @@
<info>
<link type="guide" xref="${namespace.name}.${node.parent.name}" group="vfunc"/>
</info>
- <title>${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
<synopsis><code mime="text/x-csrc">
</code></synopsis>
${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 @@
<info>
<link type="guide" xref="index" group="class"/>
</info>
- <title>${namespace.name}.${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
${formatter.format(node, node.doc)}
<synopsis><code>
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/">
<info>
</info>
- <title>${namespace.name}.${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
${formatter.format(node, node.doc)}
</page>
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 @@
<info>
<link type="guide" xref="index"/>
</info>
- <title>${node.namespace.name}.${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
${formatter.format(node, node.doc)}
% if node.members:
<table>
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
</api:function>
</info>
- <title>${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
<synopsis><code mime="text/x-python">
% 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/">
<info>
</info>
- <title>${node.name} Documentation</title>
+ <title>${formatter.format_page_name(node)}</title>
<links type="topic" ui:expanded="yes" groups="class">
<title>Classes</title>
</links>
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 @@
<link type="guide" xref="${namespace.name}.${node.parent.name}" group="property"/>
<title type="link" role="topic">${node.name}</title>
</info>
- <title>${namespace.name}.${node.parent.name}:${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
<synopsis><code mime="text/x-python">
"${node.name}" ${formatter.format_type(node.type)} : ${formatter.format_property_flags(node)}
</code></synopsis>
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 @@
<info>
<link type="guide" xref="index"/>
</info>
- <title>${node.namespace.name}${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
<p>${node.doc}</p>
</page>
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 @@
<link type="guide" xref="${namespace.name}.${node.parent.name}" group="signal"/>
<title type="link" role="topic">${node.name}</title>
</info>
- <title>${namespace.name}.${node.parent.name}::${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
<synopsis><code mime="text/x-python">
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 @@
<link type="guide" xref="${namespace.name}.${node.parent.name}" group="vfunc"/>
<title type="link" role="topic">${node.name}</title>
</info>
- <title>${namespace.name}.${node.parent.name}.${node.name}</title>
+ <title>${formatter.format_page_name(node)}</title>
<synopsis><code mime="text/x-python">
% 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 @@
<link type="guide" xref="DocExamples.Obj" group="property"/>
<title type="link" role="topic">property-example</title>
</info>
- <title>DocExamplesObj:property-example</title>
+ <title>DocExamples.Obj:property-example</title>
<p>This is an example of how to document a property.</p>
</page>
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 @@
<link type="guide" xref="DocExamples.Obj" group="signal"/>
<title type="link" role="topic">signal-example</title>
</info>
- <title>DocExamplesObj::signal-example</title>
+ <title>DocExamples.Obj::signal-example</title>
<p>This is an example of how to document a signal.</p>
</page>
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 @@
<info>
<link type="guide" xref="DocExamples.Obj" group="vfunc"/>
</info>
- <title>vfunc</title>
+ <title>DocExamples.Obj::vfunc</title>
<synopsis><code mime="text/x-csrc">
</code></synopsis>
<p>This is an example of how to document a vfunc.</p>
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 @@
<info>
<link type="guide" xref="index" group="class"/>
</info>
- <title>DocExamplesObj</title>
+ <title>DocExamples.Obj</title>
<p>This is an example of how to document a class</p><p>This class has a signal: <link xref="DocExamples.Obj-signal-example">DocExamples.Obj::signal-example</link>.</p><p>And also has a property: <link xref="DocExamples.Obj-property-example">DocExamples.Obj:property-example</link>.</p>
<p>Since 0.99</p>
<synopsis ui:expanded="no">
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 @@
<info>
<link type="guide" xref="index"/>
</info>
- <title>DocExamplesObjClass</title>
+ <title>DocExamples.ObjClass</title>
</page>
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/">
<info>
</info>
- <title>DocExamples Documentation</title>
+ <title>Index</title>
<links type="topic" ui:expanded="yes" groups="class" style="linklist">
<title>Classes</title>
</links>
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 @@
<link type="guide" xref="DocExamples.Obj" group="vfunc"/>
<title type="link" role="topic">vfunc</title>
</info>
- <title>DocExamples.Obj.vfunc</title>
+ <title>DocExamples.Obj::vfunc</title>
<synopsis><code mime="text/x-python">
@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 @@
</api:arg>
</api:function>
</info>
- <title>method</title>
+ <title>Obj.method</title>
<synopsis><code mime="text/x-python">
@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 @@
</api:arg>
</api:function>
</info>
- <title>static_method</title>
+ <title>Obj.static_method</title>
<synopsis><code mime="text/x-python">
@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/">
<info>
</info>
- <title>DocExamples Documentation</title>
+ <title>Index</title>
<links type="topic" ui:expanded="yes" groups="class">
<title>Classes</title>
</links>