ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

2004-10-11 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gdk/Pixbuf.xml
	* en/Gdk/PixbufAlphaMode.xml
	* en/Gdk/PixbufAniAnim.xml
	* en/Gdk/PixbufAniAnimIter.xml
	* en/Gdk/PixbufDestroyNotify.xml
	* en/Gdk/PixbufError.xml
	* en/Gdk/PixbufFormat.xml
	* en/Gdk/PixbufFrame.xml: Miscellaneous docs for pixbuf classes.

svn path=/trunk/gtk-sharp/; revision=34857
This commit is contained in:
Shane Landrum 2004-10-11 03:47:28 +00:00
parent 881f9655f4
commit 7908ad667b
9 changed files with 80 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/ChangeLog
View file

@ -1,3 +1,14 @@
2004-10-11 Shane Landrum <epicene@pobox.com>
* en/Gdk/Pixbuf.xml
* en/Gdk/PixbufAlphaMode.xml
* en/Gdk/PixbufAniAnim.xml
* en/Gdk/PixbufAniAnimIter.xml
* en/Gdk/PixbufDestroyNotify.xml
* en/Gdk/PixbufError.xml
* en/Gdk/PixbufFormat.xml
* en/Gdk/PixbufFrame.xml: Miscellaneous docs for pixbuf classes.
2004-09-25 Shane Landrum <epicene@pobox.com> 2004-09-25 Shane Landrum <epicene@pobox.com>
* en/Gdk/Drawable.xml * en/Gdk/Drawable.xml

26
doc/en/Gdk/Pixbuf.xml
View file

@ -1130,9 +1130,9 @@
<Parameter Name="copy_pixels" Type="System.Boolean" /> <Parameter Name="copy_pixels" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor.</summary>
<param name="data">A <see cref="T:System.Byte []"/></param> <param name="data">A <see cref="T:System.Byte []"/></param>
<param name="copy_pixels">A <see cref="T:System.Boolean"/></param> <param name="copy_pixels">A <see cref="T:System.Boolean"/>, whether to copy raw pixel data; run-length encoded pixel data is always copied.</param>
<returns>A <see cref="T:Gdk.Pixbuf"/></returns> <returns>A <see cref="T:Gdk.Pixbuf"/></returns>
<remarks/> <remarks/>
</Docs> </Docs>
@ -1194,10 +1194,10 @@
<Parameter Name="resource" Type="System.String" /> <Parameter Name="resource" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Loads a pixbuf from a resource string.</summary>
<param name="resource">a <see cref="T:System.String" /></param> <param name="resource">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixbuf" /></returns> <returns>a <see cref="T:Gdk.Pixbuf" /></returns>
<remarks/> <remarks>TODO: Clarify.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -1327,8 +1327,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The pixels contained by this Pixbuf object.</summary>
<returns>a <see cref="T:System.IntPtr" /></returns> <returns>a <see cref="T:System.IntPtr" />, pointer to the underlying C data</returns>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>
@ -1345,7 +1345,7 @@
<Parameter Name="option_values" Type="System.String[]" /> <Parameter Name="option_values" Type="System.String[]" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Saves pixbuf to a file.</summary>
<param name="filename">Name of the file where the image will be saved</param> <param name="filename">Name of the file where the image will be saved</param>
<param name="type">The file type to save (one of "ani", "bmp", "gif", "ico", "jpeg", "pcx", "png", "pnm", "ras", "tga", "tiff" "wbmp", "xpm" or "xbm")</param> <param name="type">The file type to save (one of "ani", "bmp", "gif", "ico", "jpeg", "pcx", "png", "pnm", "ras", "tga", "tiff" "wbmp", "xpm" or "xbm")</param>
<param name="option_keys">Options that are passed to the save module.</param> <param name="option_keys">Options that are passed to the save module.</param>
@ -1365,11 +1365,15 @@
<Parameter Name="type" Type="System.String" /> <Parameter Name="type" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Saves pixbuf to a file.</summary>
<param name="filename">a <see cref="T:System.String" /></param> <param name="filename">a <see cref="T:System.String" />, name of the file to save</param>
<param name="type">a <see cref="T:System.String" /></param> <param name="type">a <see cref="T:System.String" />, file format to save in ("jpeg" and "png" are supported).</param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks/> <remarks>The Gtk+ version of this call supports a text string of
arguments, which Gtk# currently does not include. (TODO: explain
the difference between Save and Savev, in light of this API
difference.)
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RenderThresholdAlpha"> <Member MemberName="RenderThresholdAlpha">

4
doc/en/Gdk/PixbufAlphaMode.xml
View file

@ -37,7 +37,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -50,7 +50,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>

2
doc/en/Gdk/PixbufAniAnim.xml
View file

@ -34,7 +34,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>

2
doc/en/Gdk/PixbufAniAnimIter.xml
View file

@ -34,7 +34,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Do not use.</summary>
<remarks/> <remarks/>
</Docs> </Docs>
</Member> </Member>

4
doc/en/Gdk/PixbufDestroyNotify.xml
View file

@ -7,8 +7,8 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Delegate class for code to be run when a <see cref="T:Gdk.Pixbuf"/> object is destroyed.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>

16
doc/en/Gdk/PixbufError.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Possible errors that can be thrown by a <see cref="T:Gdk.Pixbuf"/>.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -37,7 +37,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The image file is corrupt.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -50,7 +50,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>There is insufficient memory to hold this pixbuf data.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -63,7 +63,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>An invalid option was specified.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -76,7 +76,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The given file type is not allowed.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -89,7 +89,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The given operation is not supported.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -102,7 +102,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The operation failed.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>

30
doc/en/Gdk/PixbufFormat.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>Represents a possible format for a <see cref="T:Gdk.Pixbuf"/>.</summary>
<remarks>To be added</remarks> <remarks>Mostly for internal use.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -26,9 +26,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>A description of the format.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="MimeTypes"> <Member MemberName="MimeTypes">
@ -38,9 +38,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The MIME types supported by the format.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Extensions"> <Member MemberName="Extensions">
@ -50,9 +50,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The filename extensions typically used for files in the given format.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Name"> <Member MemberName="Name">
@ -62,9 +62,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>The name of the format.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IsWritable"> <Member MemberName="IsWritable">
@ -75,9 +75,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether pixbufs can be saved in the given format.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -88,10 +88,10 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Basic constructor.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" />, pointer to the underlying C data structure.</param>
<returns>a <see cref="T:Gdk.PixbufFormat" /></returns> <returns>a <see cref="T:Gdk.PixbufFormat" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

42
doc/en/Gdk/PixbufFrame.xml
View file

@ -11,7 +11,7 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -28,7 +28,7 @@
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -42,9 +42,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">A <see cref="T:IntPtr"/></param>
<returns>To be added: an object of type 'Gdk.PixbufFrame'</returns> <returns>A <see cref="T:Gdk.PixbufFrame"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="revert"> <Member MemberName="revert">
@ -57,9 +57,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param> <param name="value">A <see cref="T:Gdk.Pixbuf"/></param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns> <returns>A <see cref="T:Gdk.Pixbuf"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="composited"> <Member MemberName="composited">
@ -72,9 +72,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param> <param name="value">A <see cref="T:Gdk.Pixbuf"/></param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns> <returns>A <see cref="T:Gdk.Pixbuf"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="pixbuf"> <Member MemberName="pixbuf">
@ -87,9 +87,9 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param> <param name="value">A <see cref="T:Gdk.Pixbuf"/></param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns> <returns>A <see cref="T:Gdk.Pixbuf"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="XOffset"> <Member MemberName="XOffset">
@ -102,7 +102,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="YOffset"> <Member MemberName="YOffset">
@ -115,7 +115,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="DelayTime"> <Member MemberName="DelayTime">
@ -128,7 +128,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Elapsed"> <Member MemberName="Elapsed">
@ -141,7 +141,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Action"> <Member MemberName="Action">
@ -154,7 +154,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="NeedRecomposite"> <Member MemberName="NeedRecomposite">
@ -167,7 +167,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="BgTransparent"> <Member MemberName="BgTransparent">
@ -180,7 +180,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>