[pygobject] Fix the gio.unix namespace in docs
- From: Gian Mario Tagliaretti <gianmt src gnome org>
- To: svn-commits-list gnome org
- Subject: [pygobject] Fix the gio.unix namespace in docs
- Date: Tue, 23 Jun 2009 15:18:54 -0400 (EDT)
commit 2214cad3529979e29342a7e1fdc2915b90ce9c10
Author: Gian Mario Tagliaretti <gianmt gnome org>
Date: Tue Jun 23 21:18:23 2009 +0200
Fix the gio.unix namespace in docs
docs/Makefile.am | 2 ++
docs/reference/pygio-classes.xml | 2 --
docs/reference/pygio-unixinputstream.xml | 26 +++++++++++++-------------
docs/reference/pygio-unixoutputstream.xml | 26 +++++++++++++-------------
docs/reference/pygiounix-classes.xml | 13 +++++++++++++
docs/reference/pygobject-ref.xml | 1 +
6 files changed, 42 insertions(+), 28 deletions(-)
---
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 9cf8046..391eec8 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -55,6 +55,7 @@ HTML_FILES = \
html/gio-constants.html \
html/gio-functions.html \
html/gio-class-reference.html \
+ html/giounix-class-reference.html \
html/gobject-constants.html \
html/gobject-functions.html \
html/index.html \
@@ -79,6 +80,7 @@ XML_FILES = \
reference/pyglib-maincontext.xml \
reference/pyglib-mainloop.xml \
reference/pygio-classes.xml \
+ reference/pygiounix-classes.xml \
reference/pygio-constants.xml \
reference/pygio-functions.xml \
reference/pygio-applaunchcontext.xml \
diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml
index 6c96c58..17761f8 100644
--- a/docs/reference/pygio-classes.xml
+++ b/docs/reference/pygio-classes.xml
@@ -39,8 +39,6 @@
<xi:include href="pygio-seekable.xml"/>
<xi:include href="pygio-simpleasyncresult.xml"/>
<xi:include href="pygio-themedicon.xml"/>
-<xi:include href="pygio-unixinputstream.xml"/>
-<xi:include href="pygio-unixoutputstream.xml"/>
<xi:include href="pygio-volume.xml"/>
<xi:include href="pygio-volumemonitor.xml"/>
<xi:include href="pygio-functions.xml"/>
diff --git a/docs/reference/pygio-unixinputstream.xml b/docs/reference/pygio-unixinputstream.xml
index 904501d..5ef4cde 100644
--- a/docs/reference/pygio-unixinputstream.xml
+++ b/docs/reference/pygio-unixinputstream.xml
@@ -4,7 +4,7 @@
<refentry id="class-giounixinputstream">
<refnamediv>
- <refname>gio.UnixInputStream</refname>
+ <refname>gio.unix.InputStream</refname>
<refpurpose>Streaming input operations for UNIX file descriptors.</refpurpose>
</refnamediv>
@@ -12,11 +12,11 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>gio.UnixInputStream</classname></ooclass>
+ <ooclass><classname>gio.unix.InputStream</classname></ooclass>
<ooclass><classname><link linkend="class-gioinputstream">gio.InputStream</link></classname></ooclass>
<constructorsynopsis language="python">
- <methodname><link linkend="constructor-giounixinputstream">gio.UnixInputStream</link></methodname>
+ <methodname><link linkend="constructor-giounixinputstream">gio.unix.InputStream</link></methodname>
<methodparam><parameter role="keyword">fd</parameter></methodparam>
<methodparam><parameter role="keyword">close_fd</parameter></methodparam>
</constructorsynopsis>
@@ -43,13 +43,13 @@
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gioinputstream">gio.InputStream</link>
- +-- <link linkend="class-giounixinputstream">gio.UnixInputStream</link>
+ +-- <link linkend="class-giounixinputstream">gio.unix.InputStream</link>
</synopsis>
</refsect1>
<refsect1 id="properties-giounixinputstream">
- <title>gio.UnixInputStream Properties</title>
+ <title>gio.unix.InputStream Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
@@ -80,13 +80,13 @@
<title>Description</title>
<para>
- <link linkend="class-giounixinputstream"><classname>gio.UnixInputStream</classname></link>
+ <link linkend="class-giounixinputstream"><classname>gio.unix.InputStream</classname></link>
implements <link linkend="class-gioinputstream"><classname>gio.InputStream</classname></link>
for reading from a UNIX file descriptor, including asynchronous operations.
The file descriptor must be selectable, so it doesn't work with opened files.
</para>
<para>
- Note that <link linkend="class-giounixinputstream"><classname>gio.UnixInputStream</classname></link>
+ Note that <link linkend="class-giounixinputstream"><classname>gio.unix.InputStream</classname></link>
belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file
when using it.
</para>
@@ -96,7 +96,7 @@
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
- <methodname>gio.UnixInputStream</methodname>
+ <methodname>gio.unix.InputStream</methodname>
<methodparam><parameter role="keyword">fd</parameter></methodparam>
<methodparam><parameter role="keyword">close_fd</parameter></methodparam>
</constructorsynopsis></programlisting>
@@ -115,13 +115,13 @@
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new
- <link linkend="class-giounixinputstream"><classname>gio.UnixInputStream</classname></link>
+ <link linkend="class-giounixinputstream"><classname>gio.unix.InputStream</classname></link>
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
- Creates a new <link linkend="class-giounixinputstream"><classname>gio.UnixInputStream</classname></link>
+ Creates a new <link linkend="class-giounixinputstream"><classname>gio.unix.InputStream</classname></link>
from the given fd.
</para>
<para>
@@ -134,7 +134,7 @@
<title>Methods</title>
<refsect2 id="method-giounixinputstream--get-close-fd">
- <title>gio.UnixInputStream.get_close_fd</title>
+ <title>gio.unix.InputStream.get_close_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>get_close_fd</methodname>
@@ -156,7 +156,7 @@
</refsect2>
<refsect2 id="method-giounixinputstream--get-fd">
- <title>gio.UnixInputStream.get_fd</title>
+ <title>gio.unix.InputStream.get_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>get_fd</methodname>
@@ -178,7 +178,7 @@
</refsect2>
<refsect2 id="method-giounixinputstream--set-close-fd">
- <title>gio.UnixInputStream.set_close_fd</title>
+ <title>gio.unix.InputStream.set_close_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>set_close_fd</methodname>
diff --git a/docs/reference/pygio-unixoutputstream.xml b/docs/reference/pygio-unixoutputstream.xml
index cebc623..02e4be8 100644
--- a/docs/reference/pygio-unixoutputstream.xml
+++ b/docs/reference/pygio-unixoutputstream.xml
@@ -4,7 +4,7 @@
<refentry id="class-giounixoutputstream">
<refnamediv>
- <refname>gio.UnixOutputStream</refname>
+ <refname>gio.unix.OutputStream</refname>
<refpurpose>Streaming output operations for UNIX file descriptors.</refpurpose>
</refnamediv>
@@ -12,11 +12,11 @@
<title>Synopsis</title>
<classsynopsis language="python">
- <ooclass><classname>gio.UnixOutputStream</classname></ooclass>
+ <ooclass><classname>gio.unix.OutputStream</classname></ooclass>
<ooclass><classname><link linkend="class-giooutputstream">gio.OutputStream</link></classname></ooclass>
<constructorsynopsis language="python">
- <methodname><link linkend="constructor-giounixoutputstream">gio.UnixOutputStream</link></methodname>
+ <methodname><link linkend="constructor-giounixoutputstream">gio.unix.OutputStream</link></methodname>
<methodparam><parameter role="keyword">fd</parameter></methodparam>
<methodparam><parameter role="keyword">close_fd</parameter></methodparam>
</constructorsynopsis>
@@ -43,13 +43,13 @@
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-giooutputstream">gio.OutputStream</link>
- +-- <link linkend="class-giounixoutputstream">gio.UnixOutputStream</link>
+ +-- <link linkend="class-giounixoutputstream">gio.unix.OutputStream</link>
</synopsis>
</refsect1>
<refsect1 id="properties-giounixoutputstream">
- <title>gio.UnixOutputStream Properties</title>
+ <title>gio.unix.OutputStream Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
@@ -80,13 +80,13 @@
<title>Description</title>
<para>
- <link linkend="class-giounixoutputstream"><classname>gio.UnixOutputStream</classname></link>
+ <link linkend="class-giounixoutputstream"><classname>gio.unix.OutputStream</classname></link>
implements <link linkend="class-giooutputstream"><classname>gio.OutputStream</classname></link>
for writing to a UNIX file descriptor, including asynchronous operations.
The file descriptor must be selectable, so it doesn't work with opened files.
</para>
<para>
- Note that <link linkend="class-giounixoutputstream"><classname>gio.UnixOutputStream</classname></link>
+ Note that <link linkend="class-giounixoutputstream"><classname>gio.unix.OutputStream</classname></link>
belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file
when using it.
</para>
@@ -96,7 +96,7 @@
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
- <methodname>gio.UnixOutputStream</methodname>
+ <methodname>gio.unix.OutputStream</methodname>
<methodparam><parameter role="keyword">fd</parameter></methodparam>
<methodparam><parameter role="keyword">close_fd</parameter></methodparam>
</constructorsynopsis></programlisting>
@@ -115,13 +115,13 @@
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new
- <link linkend="class-giounixoutputstream"><classname>gio.UnixOutputStream</classname></link>
+ <link linkend="class-giounixoutputstream"><classname>gio.unix.OutputStream</classname></link>
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
- Creates a new <link linkend="class-giounixoutputstream"><classname>gio.UnixOutputStream</classname></link>
+ Creates a new <link linkend="class-giounixoutputstream"><classname>gio.unix.OutputStream</classname></link>
from the given fd.
</para>
<para>
@@ -134,7 +134,7 @@
<title>Methods</title>
<refsect2 id="method-giounixoutputstream--get-close-fd">
- <title>gio.UnixOutputStream.get_close_fd</title>
+ <title>gio.unix.OutputStream.get_close_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>get_close_fd</methodname>
@@ -156,7 +156,7 @@
</refsect2>
<refsect2 id="method-giounixoutputstream--get-fd">
- <title>gio.UnixOutputStream.get_fd</title>
+ <title>gio.unix.OutputStream.get_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>get_fd</methodname>
@@ -178,7 +178,7 @@
</refsect2>
<refsect2 id="method-giounixoutputstream--set-close-fd">
- <title>gio.UnixOutputStream.set_close_fd</title>
+ <title>gio.unix.OutputStream.set_close_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>set_close_fd</methodname>
diff --git a/docs/reference/pygiounix-classes.xml b/docs/reference/pygiounix-classes.xml
new file mode 100644
index 0000000..72b0081
--- /dev/null
+++ b/docs/reference/pygiounix-classes.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+<chapter id="giounix-class-reference"
+ xmlns:xi="http://www.w3.org/2001/XInclude";>
+
+<title>PyGio Unix Class Reference</title>
+
+<!-- GIOUNIX CLASSES -->
+<xi:include href="pygio-unixinputstream.xml"/>
+<xi:include href="pygio-unixoutputstream.xml"/>
+
+</chapter>
diff --git a/docs/reference/pygobject-ref.xml b/docs/reference/pygobject-ref.xml
index 08dd1dd..5fdd80b 100644
--- a/docs/reference/pygobject-ref.xml
+++ b/docs/reference/pygobject-ref.xml
@@ -25,6 +25,7 @@ module.</para>
<xi:include href="pyglib-classes.xml"/>
<xi:include href="pygobject-classes.xml"/>
<xi:include href="pygio-classes.xml"/>
+ <xi:include href="pygiounix-classes.xml"/>
<!--
<index>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
