[nautilus-python] Added nautilus.PropertyPage gtk-doc documentation
- From: Adam Plumb <adamplumb src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [nautilus-python] Added nautilus.PropertyPage gtk-doc documentation
- Date: Fri, 21 May 2010 15:55:49 +0000 (UTC)
commit 20cf252d4f138c84edbc1e937f6c46cdfe6b02ec
Author: Adam Plumb <adamplumb gmail com>
Date: Thu May 20 17:38:01 2010 -0400
Added nautilus.PropertyPage gtk-doc documentation
docs/Makefile.am | 4 +-
docs/reference/nautilus-python-menu-item.xml | 185 ++--------------------
docs/reference/nautilus-python-property-page.xml | 135 ++++++++++++++++
docs/reference/nautilus-python-ref.xml | 1 +
4 files changed, 152 insertions(+), 173 deletions(-)
---
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 87855dc..2d33453 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -12,7 +12,8 @@ XMLFILES = \
reference/nautilus-python-column-provider.xml \
reference/nautilus-python-menu.xml \
reference/nautilus-python-menu-item.xml \
- reference/nautilus-python-menu-provider.xml
+ reference/nautilus-python-menu-provider.xml \
+ reference/nautilus-python-property-page.xml
HTMLdir = $(datadir)/gtk-doc/html/nautilus-python
HTML_DATA = \
@@ -23,6 +24,7 @@ HTML_DATA = \
html/class-nautilus-python-menu.html \
html/class-nautilus-python-menu-item.html \
html/class-nautilus-python-menu-provider.html \
+ html/class-nautilus-python-property-page.html \
html/nautilus-python.devhelp
CSS_FILES = $(PYGOBJECT_PYGDOCS)/style.css
diff --git a/docs/reference/nautilus-python-menu-item.xml b/docs/reference/nautilus-python-menu-item.xml
index 6f798cc..eaec20f 100644
--- a/docs/reference/nautilus-python-menu-item.xml
+++ b/docs/reference/nautilus-python-menu-item.xml
@@ -83,44 +83,44 @@
<row valign="top">
<entry>"<link linkend="property-nautilus-python-menu-item--icon">icon</link>"</entry>
- <entry>string</entry>
<entry>Read / Write</entry>
+ <entry>Name of the icon to display in the menu item. Default value: None</entry>
</row>
<row valign="top">
<entry>"<link linkend="property-nautilus-python-menu-item--label">label</link>"</entry>
- <entry>string</entry>
<entry>Read / Write</entry>
+ <entry>The label to display to the user. Default value: None</entry>
</row>
<row valign="top">
<entry>"<link linkend="property-nautilus-python-menu-item--menu">menu</link>"</entry>
- <entry><link linkend="class-nautilus-python-menu">nautilus.Menu</link></entry>
<entry>Read / Write</entry>
+ <entry>The <link linkend="class-nautilus-python-menu">nautilus.Menu</link> menu object belonging to this item. May be None.</entry>
</row>
<row valign="top">
<entry>"<link linkend="property-nautilus-python-menu-item--name">name</link>"</entry>
- <entry>string</entry>
- <entry>Read / Write / Construct Only</entry>
+ <entry>Read / Write</entry>
+ <entry>The name of the item. Default value: None</entry>
</row>
<row valign="top">
<entry>"<link linkend="property-nautilus-python-menu-item--priority">priority</link>"</entry>
- <entry>boolean</entry>
<entry>Read / Write</entry>
+ <entry>Whether or not to show priority text in toolbars. Default value: True</entry>
</row>
<row valign="top">
<entry>"<link linkend="property-nautilus-python-menu-item--sensitive">sensitive</link>"</entry>
- <entry>boolean</entry>
<entry>Read / Write</entry>
+ <entry>Whether or not the menu item is sensitive. Default value: True</entry>
</row>
<row valign="top">
<entry>"<link linkend="property-nautilus-python-menu-item--tip">tip</link>"</entry>
- <entry>string</entry>
<entry>Read / Write</entry>
+ <entry>The tooltip for the menu item. Default value: None</entry>
</row>
</tbody>
@@ -143,7 +143,6 @@
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>item</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>user_param2</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
@@ -232,167 +231,6 @@
<!-- ******************************** -->
-<!-- BEGIN OF PROPERTY DETAILS -->
-<!-- ******************************** -->
-<refsect1>
- <title>Property Details</title>
-
- <refsect2 id="property-nautilus-python-menu-item--icon">
- <title>The "name" property</title>
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec menu="1" colwidth="1in"/>
- <colspec menu="2" colwidth="1in"/>
- <colspec menu="3" colwidth="4in"/>
- <tbody>
- <row valign="top">
- <entry>"icon"</entry>
- <entry>string</entry>
- <entry>Read / Write</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
- <para>Name of the icon to display in the menu item.</para>
- <para>Default value: None</para>
- </refsect2>
-
- <refsect2 id="property-nautilus-python-menu-item--label">
- <title>The "label" property</title>
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec menu="1" colwidth="1in"/>
- <colspec menu="2" colwidth="1in"/>
- <colspec menu="3" colwidth="4in"/>
- <tbody>
- <row valign="top">
- <entry>"label"</entry>
- <entry>string</entry>
- <entry>Read / Write</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
- <para>Label to display to the user.</para>
- <para>Default value: None</para>
- </refsect2>
-
- <refsect2 id="property-nautilus-python-menu-item--menu">
- <title>The "menu" property</title>
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec menu="1" colwidth="1in"/>
- <colspec menu="2" colwidth="1in"/>
- <colspec menu="3" colwidth="4in"/>
- <tbody>
- <row valign="top">
- <entry>"menu"</entry>
- <entry><link linkend="class-nautilus-python-menu-item">nautilus.Menu</link></entry>
- <entry>Read / Write</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
- <para>The menu belonging to this item. May be null.</para>
- </refsect2>
-
- <refsect2 id="property-nautilus-python-menu-item--name">
- <title>The "name" property</title>
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec menu="1" colwidth="1in"/>
- <colspec menu="2" colwidth="1in"/>
- <colspec menu="3" colwidth="4in"/>
- <tbody>
- <row valign="top">
- <entry>"name"</entry>
- <entry>string</entry>
- <entry>Read / Write / Construct Only</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
- <para>Name of the item.</para>
- <para>Default value: None</para>
- </refsect2>
-
- <refsect2 id="property-nautilus-python-menu-item--priority">
- <title>The "priority" property</title>
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec menu="1" colwidth="1in"/>
- <colspec menu="2" colwidth="1in"/>
- <colspec menu="3" colwidth="4in"/>
- <tbody>
- <row valign="top">
- <entry>"priority"</entry>
- <entry>boolean</entry>
- <entry>Read / Write</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
- <para>Show priority text in toolbars.</para>
- <para>Default value: True</para>
- </refsect2>
-
- <refsect2 id="property-nautilus-python-menu-item--sensitive">
- <title>The "sensitive" property</title>
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec menu="1" colwidth="1in"/>
- <colspec menu="2" colwidth="1in"/>
- <colspec menu="3" colwidth="4in"/>
- <tbody>
- <row valign="top">
- <entry>"sensitive"</entry>
- <entry>boolean</entry>
- <entry>Read / Write</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
- <para>Whether the menu item is sensitive.</para>
- <para>Default value: True</para>
- </refsect2>
-
- <refsect2 id="property-nautilus-python-menu-item--tip">
- <title>The "tip" property</title>
- <blockquote role="properties">
- <informaltable pgwide="1" frame="none">
- <tgroup cols="3">
- <colspec menu="1" colwidth="1in"/>
- <colspec menu="2" colwidth="1in"/>
- <colspec menu="3" colwidth="4in"/>
- <tbody>
- <row valign="top">
- <entry>"tip"</entry>
- <entry>string</entry>
- <entry>Read / Write</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </blockquote>
- <para>Tooltip for the menu item.</para>
- <para>Default value: None</para>
- </refsect2>
-</refsect1>
-
-
-<!-- ******************************** -->
<!-- BEGIN OF SIGNAL DETAILS -->
<!-- ******************************** -->
@@ -406,7 +244,6 @@
<methodname>callback</methodname>
<methodparam><parameter>item</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
- <methodparam><parameter>user_param2</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
@@ -416,7 +253,11 @@
<listitem><simpara>the <link linkend="class-nautilus-python-menu-item"><classname>nautilus.MenuItem</classname></link> being activated</simpara></listitem>
</varlistentry>
<varlistentry>
- <term><parameter>user_param1[,2,3...]</parameter> :</term>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>User-defined parameter the user attaches to the signal connector</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
<listitem><simpara>Additional parameter(s) the user attaches to the signal connector</simpara></listitem>
</varlistentry>
</variablelist>
diff --git a/docs/reference/nautilus-python-property-page.xml b/docs/reference/nautilus-python-property-page.xml
new file mode 100644
index 0000000..b8e65df
--- /dev/null
+++ b/docs/reference/nautilus-python-property-page.xml
@@ -0,0 +1,135 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+
+<refentry id="class-nautilus-python-property-page">
+ <refnamediv>
+ <refname>nautilus.PropertyPage</refname>
+ <refpurpose>nautilus.PropertyPage Reference</refpurpose>
+ </refnamediv>
+
+<!-- ******************************* -->
+<!-- BEGIN OF NAUTILUS-PYTHON SYNOPSIS -->
+<!-- ******************************* -->
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>nautilus.PropertyPage</classname></ooclass>
+ <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
+
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-nautilus-property-page">nautilus.PropertyPage</link></methodname>
+ <methodparam><parameter role="keyword">name</parameter></methodparam>
+ <methodparam><parameter role="keyword">label</parameter></methodparam>
+ <methodparam><parameter role="keyword">page</parameter></methodparam>
+ </constructorsynopsis>
+ </classsynopsis>
+ </refsect1>
+
+<!-- ********************************* -->
+<!-- BEGIN OF ANCESTRY -->
+<!-- ********************************* -->
+
+<refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+ +-- <link linkend="class-nautilus-python-property-page">nautilus.PropertyPage</link>
+</synopsis>
+</refsect1>
+
+
+<!-- ********************************** -->
+<!-- BEGIN OF DESCRIPTION -->
+<!-- ********************************** -->
+
+ <refsect1 id="description-property-page">
+ <title>Description</title>
+
+ <para>
+ A <link linkend="class-nautilus-python-property-page"><classname>nautilus.PropertyPage</classname></link> object is returned by <link linkend="class-nautilus-python-property-page-provider"><classname>nautilus.PropertyPageProvider</classname></link> extensions.
+ </para>
+
+ </refsect1>
+
+
+<!-- *********************************** -->
+<!-- BEGIN OF PROPERTIES -->
+<!-- *********************************** -->
+
+<refsect1>
+ <title>Properties</title>
+
+ <blockquote role="properties">
+ <informaltable pgwide="1" frame="none">
+ <tgroup cols="3">
+ <colspec property-page="1" colwidth="1in"/>
+ <colspec property-page="2" colwidth="1in"/>
+ <colspec property-page="3" colwidth="4in"/>
+ <tbody>
+
+ <row valign="top">
+ <entry>"label"</entry>
+ <entry>Read / Write</entry>
+ <entry>The label widget displayed in the notebook tab.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"name"</entry>
+ <entry>Read / Write / Construct Only</entry>
+ <entry>The name of the page. Default value: None</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"page"</entry>
+ <entry>Read / Write</entry>
+ <entry>The property page widget</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </blockquote>
+</refsect1>
+
+
+<!-- ************************************ -->
+<!-- BEGIN OF CONSTRUCTOR -->
+<!-- ************************************ -->
+
+<refsect1 id="constructor-nautilus-property-page">
+ <title>Constructor</title>
+
+ <programlisting><constructorsynopsis language="python">
+ <methodname>nautilus.PropertyPage</methodname>
+ <methodparam><parameter role="keyword">name</parameter></methodparam>
+ <methodparam><parameter role="keyword">label</parameter></methodparam>
+ <methodparam><parameter role="keyword">page</parameter></methodparam>
+ </constructorsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">name</parameter> :</term>
+ <listitem><simpara>identifier of the property page</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">label</parameter> :</term>
+ <listitem><simpara>the user-visible label for the property page</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">page</parameter> :</term>
+ <listitem><simpara>the property page widget</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Creates a new <link linkend="class-nautilus-python-property-page"><classname>nautilus.PropertyPage</classname></link> object.
+ </para>
+</refsect1>
+
+
+
+</refentry>
+
diff --git a/docs/reference/nautilus-python-ref.xml b/docs/reference/nautilus-python-ref.xml
index b406727..d314c02 100644
--- a/docs/reference/nautilus-python-ref.xml
+++ b/docs/reference/nautilus-python-ref.xml
@@ -32,5 +32,6 @@
<xi:include href="nautilus-python-menu.xml"/>
<xi:include href="nautilus-python-menu-item.xml"/>
<xi:include href="nautilus-python-menu-provider.xml"/>
+ <xi:include href="nautilus-python-property-page.xml"/>
</book>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
