diff options
| author | Gian Mario Tagliaretti <gianmt@gnome.org> | 2009-06-13 14:38:34 +0200 |
|---|---|---|
| committer | Gian Mario Tagliaretti <gianmt@gnome.org> | 2009-06-13 14:38:34 +0200 |
| commit | a6e25aaa7c8f27d62f2917b06728d7ccfcd46416 (patch) | |
| tree | 38e67e909cb3b23e4ccaf64f63fe3b7ea8a0e63b /docs/reference | |
| parent | a9b13b60a5aad726d7d7dd7fdc5153b1561fb591 (diff) | |
| download | pygobject-a6e25aaa7c8f27d62f2917b06728d7ccfcd46416.tar.gz pygobject-a6e25aaa7c8f27d62f2917b06728d7ccfcd46416.tar.xz pygobject-a6e25aaa7c8f27d62f2917b06728d7ccfcd46416.zip | |
Fix gio.BufferedInputStream docs
Added the constructor reference and fixed a typo in properties header
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | 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> |