[gtk-doc] Adjust how function parameters are displayed
- From: William Jon McCann <mccann src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] Adjust how function parameters are displayed
- Date: Wed, 12 Feb 2014 15:14:14 +0000 (UTC)
commit ba99fc0cba28ea0ac80a9f99b588734c81c752f5
Author: William Jon McCann <william jon mccann gmail com>
Date: Mon Feb 10 12:26:29 2014 -0500
Adjust how function parameters are displayed
Use separate sections for parameters and results. Display
parameters as a table.
https://bugzilla.gnome.org/show_bug.cgi?id=723991
gtkdoc-mkdb.in | 40 +++++++++++++++++++++++-----------------
style/style.css | 6 +++++-
2 files changed, 28 insertions(+), 18 deletions(-)
---
diff --git a/gtkdoc-mkdb.in b/gtkdoc-mkdb.in
index 6fa6f76..00e160d 100755
--- a/gtkdoc-mkdb.in
+++ b/gtkdoc-mkdb.in
@@ -2297,12 +2297,11 @@ sub OutputParamDescriptions {
($param_desc,$param_annotations) = & ExpandAnnotation($symbol, $param_desc);
$param_desc = &ConvertMarkDown($symbol, $param_desc);
- $param_desc .= $param_annotations;
# trim
$param_desc =~ s/^(\s|\n)+//msg;
$param_desc =~ s/(\s|\n)+$//msg;
if ($param_name eq "Returns") {
- $returns = "$param_desc";
+ $returns = "$param_desc\n<para>$param_annotations</para>";
} elsif ($param_name eq "void") {
#print "!!!! void in params for $symbol?\n";
} else {
@@ -2320,7 +2319,7 @@ sub OutputParamDescriptions {
}
}
if($param_desc ne "") {
- $params_desc .=
"<varlistentry><term><parameter>$param_name</parameter> :</term>\n<listitem>$param_desc</listitem></varlistentry>\n";
+ $params_desc .= "<row><entry
role=\"parameter_name\"><para>$param_name</para></entry>\n<entry
role=\"parameter_description\">$param_desc</entry>\n<entry
role=\"parameter_annotations\">$param_annotations</entry></row>\n";
$num_params++;
}
}
@@ -2337,24 +2336,31 @@ sub OutputParamDescriptions {
# Signals have an implicit user_data parameter which we describe.
if ($symbol_type eq "SIGNAL") {
- $params_desc .=
"<varlistentry><term><parameter>user_data</parameter> :</term>\n<listitem><simpara>user data set when
the signal handler was connected.</simpara></listitem></varlistentry>\n";
+ $params_desc .= "<row><entry
role=\"parameter_name\"><simpara>user_data</simpara></entry>\n<entry
role=\"parameter_description\"><simpara>user data set when the signal handler was
connected.</simpara></entry>\n<entry role=\"parameter_annotations\"></entry></row>\n";
}
# Start a table if we need one.
- if ($params_desc || $returns) {
- $output .= "<variablelist role=\"params\">\n";
- if ($params_desc ne "") {
- #$output .= "<varlistentry><term>Parameters:</term><listitem></listitem></varlistentry>\n";
- $output .= $params_desc;
- }
-
- # Output the returns info last
- if ($returns) {
- $output .=
"<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem>$returns</listitem></varlistentry>\n";
- }
+ if ($params_desc ne "") {
+ $output .= <<EOF;
+<refsect3 role="parameters">\n<title>Parameters</title>
+<informaltable role="parameters_table" pgwide="1" frame="none">
+<tgroup cols="3">
+<colspec colname="name" colwidth="150px"/>
+<colspec colname="description"/>
+<colspec colname="annotations" colwidth="200px"/>
+<tbody>
+EOF
+ $output .= $params_desc;
+ $output .= "</tbody></tgroup></informaltable>\n</refsect3>";
+ }
- # Finish the table.
- $output .= "</variablelist>";
+ # Output the returns info last
+ if ($returns ne "") {
+ $output .= <<EOF;
+<refsect3 role=\"returns\">\n<title>Returns</title>
+EOF
+ $output .= $returns;
+ $output .= "\n</refsect3>";
}
# remember missing/unused parameters (needed in tmpl-free build)
diff --git a/style/style.css b/style/style.css
index 42d0824..9cafc7e 100644
--- a/style/style.css
+++ b/style/style.css
@@ -173,6 +173,11 @@ div.informaltable table td, div.informaltable table th
color: #555753;
}
+.parameter_name
+{
+ text-align: right;
+}
+
div.table table
{
border-collapse: collapse;
@@ -310,7 +315,6 @@ h2 .extralinks, h3 .extralinks
{
/* tango:aluminium 5 */
color: #555753;
- font-size: 80%;
font-weight: normal;
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]