[gtk-doc] mkdb: use a table for property details
- From: Stefan Kost <stefkost src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] mkdb: use a table for property details
- Date: Thu, 13 Feb 2014 19:53:04 +0000 (UTC)
commit ece54f5736c80fce76276a85934c5a5585ea0730
Author: Stefan Sauer <ensonic users sf net>
Date: Thu Feb 13 20:51:18 2014 +0100
mkdb: use a table for property details
Reorder part of property docs. Have the description right after the synopsis.
Then the deprecation note followed by a table of details.
gtkdoc-mkdb.in | 20 ++++++++++++++------
style/style.css | 3 ++-
2 files changed, 16 insertions(+), 7 deletions(-)
---
diff --git a/gtkdoc-mkdb.in b/gtkdoc-mkdb.in
index 1013062..3b7036d 100755
--- a/gtkdoc-mkdb.in
+++ b/gtkdoc-mkdb.in
@@ -3736,18 +3736,26 @@ sub GetArgs {
$arg_desc .= OutputSymbolExtraLinks($symbol);
$arg_desc .= "<programlisting> “$name”$pad1 $type_output</programlisting>\n";
+ $arg_desc .= $blurb;
+ $arg_desc .= &MakeDeprecationNote($symbol);
+
+ $arg_desc .= <<EOF;
+<informaltable role="property_details_table" pgwide="1" frame="none">
+<tgroup cols="2">
+<colspec colname="parameters_name" colwidth="150px"/>
+<colspec colname="parameters_description"/>
+<tbody>
+EOF
if ($flags_string) {
- $arg_desc .= "<para>Flags: $flags_string</para>\n";
+ $arg_desc .= "<row><entry
role=\"property_detail\">Flags</entry><entry>$flags_string</entry></row>\n";
}
-
- $arg_desc .= &MakeDeprecationNote($symbol);
- $arg_desc .= $blurb;
if ($range ne "") {
- $arg_desc .= "<para>Allowed values: $range_output</para>\n";
+ $arg_desc .= "<row><entry role=\"property_detail\">Allowed
values</entry><entry>$range_output</entry></row>\n";
}
if ($default ne "") {
- $arg_desc .= "<para>Default value: $default_output</para>\n";
+ $arg_desc .= "<row><entry role=\"property_detail\">Default
value</entry><entry>$default_output</entry></row>\n";
}
+ $arg_desc .= "</tbody></tgroup></informaltable>\n";
$arg_desc .= OutputSymbolTraits ($symbol);
$arg_desc .= "</refsect2>\n";
diff --git a/style/style.css b/style/style.css
index 9c17d50..3643076 100644
--- a/style/style.css
+++ b/style/style.css
@@ -197,7 +197,8 @@ div.informaltable table td, div.informaltable table th
.struct_member_name,
.union_member_name,
.define_keyword,
-.datatype_keyword
+.datatype_keyword,
+.property_detail
{
text-align: right;
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]