[pygobject] Fix gio.BufferedInputStream docs
- From: Gian Mario Tagliaretti <gianmt src gnome org>
- To: svn-commits-list gnome org
- Subject: [pygobject] Fix gio.BufferedInputStream docs
- Date: Sat, 13 Jun 2009 08:45:24 -0400 (EDT)
commit a6e25aaa7c8f27d62f2917b06728d7ccfcd46416
Author: Gian Mario Tagliaretti <gianmt gnome org>
Date: Sat Jun 13 14:38:34 2009 +0200
Fix gio.BufferedInputStream docs
Added the constructor reference and fixed a typo in properties header
docs/reference/pygio-bufferedinputstream.xml | 34 ++++++++++++++++++++++++-
1 files changed, 32 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/pygio-bufferedinputstream.xml b/docs/reference/pygio-bufferedinputstream.xml
index 97d5046..677b1da 100644
--- a/docs/reference/pygio-bufferedinputstream.xml
+++ b/docs/reference/pygio-bufferedinputstream.xml
@@ -77,8 +77,8 @@
</refsect1>
- <refsect1 id="properties-giofilterinputstream">
- <title>gio.FilterInputStream Properties</title>
+ <refsect1 id="properties-giobufferedinputstream">
+ <title>gio.BufferedInputStream Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
@@ -127,6 +127,36 @@
</para>
</refsect1>
+ <refsect1 id="constructor-giobufferedinputstream">
+ <title>Constructor</title>
+
+ <programlisting><constructorsynopsis language="python">
+ <methodname>gio.BufferedInputStream</methodname>
+ <methodparam><parameter role="keyword">base_stream</parameter></methodparam>
+ </constructorsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>base_stream</parameter> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gioinputstream"><classname>gio.InputStream</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new
+ <link linkend="class-gioinputstream"><classname>gio.InputStream</classname></link>
+ for the given base_stream.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Creates a new <link linkend="class-gioinputstream"><classname>gio.InputStream</classname></link>
+ from the given base_stream, with a buffer set to the default size (4 kilobytes).
+ </para>
+
+ </refsect1>
+
<refsect1>
<title>Methods</title>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]