ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2025-05-11 21:52:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

2004-08-29 Shane Landrum <epicene@pobox.com>

Browse source 
* HTML.xml
	* HTMLBeginFlags.xml
	* HTMLClassProperties.xml
	* HTMLCommandType.xml
	* HTMLEditorAPI.xml
	* HTMLEditorEventType.xml
	* HTMLFontStyleShift.xml
	* HTMLParagraphStyle.xml
	* HTMLPrintCallback.xml
	* HTMLStream.xml
	* HTMLStreamCloseFunc.xml
	* HTMLStreamStatus.xml
	* HTMLStreamTypesFunc.xml
	* HTMLStreamWriteFunc.xml: Documented HTML widget and related classes.

svn path=/trunk/gtk-sharp/; revision=32980
This commit is contained in:
Shane Landrum 2004-08-29 06:52:31 +00:00
parent 524450a235
commit e35b797518
15 changed files with 127 additions and 109 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/ChangeLog
View file

@ -1,3 +1,20 @@
2004-08-29 Shane Landrum <epicene@pobox.com>
* HTML.xml
* HTMLBeginFlags.xml
* HTMLClassProperties.xml
* HTMLCommandType.xml
* HTMLEditorAPI.xml
* HTMLEditorEventType.xml
* HTMLFontStyleShift.xml
* HTMLParagraphStyle.xml
* HTMLPrintCallback.xml
* HTMLStream.xml
* HTMLStreamCloseFunc.xml
* HTMLStreamStatus.xml
* HTMLStreamTypesFunc.xml
* HTMLStreamWriteFunc.xml: Documented HTML widget and related classes.
2004-08-28 Shane Landrum <epicene@pobox.com> 2004-08-28 Shane Landrum <epicene@pobox.com>
* en/Gtk/HSV.xml: Added docs for color selector. * en/Gtk/HSV.xml: Added docs for color selector.

24
doc/en/Gtk/HTML.xml
View file

@ -587,7 +587,7 @@ class X {
<Parameter Name="flags" Type="Gtk.HTMLBeginFlags" /> <Parameter Name="flags" Type="Gtk.HTMLBeginFlags" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Begins processing HTML.</summary>
<param name="target_frame">an object of type <see cref="T:System.String" /></param> <param name="target_frame">an object of type <see cref="T:System.String" /></param>
<param name="content_type">an object of type <see cref="T:System.String" /></param> <param name="content_type">an object of type <see cref="T:System.String" /></param>
<param name="flags">an object of type <see cref="T:Gtk.HTMLBeginFlags" /></param> <param name="flags">an object of type <see cref="T:Gtk.HTMLBeginFlags" /></param>
@ -650,7 +650,7 @@ class X {
<Parameter Name="to_be_destroyed" Type="Gtk.HTML" /> <Parameter Name="to_be_destroyed" Type="Gtk.HTML" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added.</summary>
<param name="to_be_destroyed">an object of type <see cref="T:Gtk.HTML" /></param> <param name="to_be_destroyed">an object of type <see cref="T:Gtk.HTML" /></param>
<remarks /> <remarks />
</Docs> </Docs>
@ -693,7 +693,7 @@ class X {
<Parameter Name="or_mask" Type="Gtk.HTMLFontStyle" /> <Parameter Name="or_mask" Type="Gtk.HTMLFontStyle" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the font style for the widget.</summary>
<param name="and_mask">an object of type <see cref="T:Gtk.HTMLFontStyle" /></param> <param name="and_mask">an object of type <see cref="T:Gtk.HTMLFontStyle" /></param>
<param name="or_mask">an object of type <see cref="T:Gtk.HTMLFontStyle" /></param> <param name="or_mask">an object of type <see cref="T:Gtk.HTMLFontStyle" /></param>
<remarks /> <remarks />
@ -709,9 +709,9 @@ class X {
<Parameter Name="url" Type="System.String" /> <Parameter Name="url" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Unrefs an image.</summary>
<param name="url">an object of type <see cref="T:System.String" /></param> <param name="url">an object of type <see cref="T:System.String" /></param>
<remarks /> <remarks>(TODO: explain refcounting for images.)</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ImageRef"> <Member MemberName="ImageRef">
@ -724,7 +724,7 @@ class X {
<Parameter Name="url" Type="System.String" /> <Parameter Name="url" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Refs an image.</summary>
<param name="url">an object of type <see cref="T:System.String" /></param> <param name="url">an object of type <see cref="T:System.String" /></param>
<remarks /> <remarks />
</Docs> </Docs>
@ -791,7 +791,7 @@ class X {
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Unrefs images.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -1651,12 +1651,12 @@ class X {
<Parameter Name="footer_print" Type="Gtk.HTMLPrintCallback" /> <Parameter Name="footer_print" Type="Gtk.HTMLPrintCallback" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Adds a header and footer to the HTML and prints it using <paramref name="print_context"/>.</summary>
<param name="print_context">a <see cref="T:Gnome.PrintContext" /></param> <param name="print_context">a <see cref="T:Gnome.PrintContext" /></param>
<param name="header_height">a <see cref="T:System.Double" /></param> <param name="header_height">a <see cref="T:System.Double" /></param>
<param name="footer_height">a <see cref="T:System.Double" /></param> <param name="footer_height">a <see cref="T:System.Double" /></param>
<param name="header_print">a <see cref="T:Gtk.HTMLPrintCallback" /></param> <param name="header_print">a <see cref="T:Gtk.HTMLPrintCallback" />, a header generation routine</param>
<param name="footer_print">a <see cref="T:Gtk.HTMLPrintCallback" /></param> <param name="footer_print">a <see cref="T:Gtk.HTMLPrintCallback" />, a footer generation routine</param>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -1685,7 +1685,7 @@ class X {
<Parameter Name="print_context" Type="Gnome.PrintContext" /> <Parameter Name="print_context" Type="Gnome.PrintContext" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Prints this document using <paramref name="print_context"/>.</summary>
<param name="print_context">a <see cref="T:Gnome.PrintContext" /></param> <param name="print_context">a <see cref="T:Gnome.PrintContext" /></param>
<remarks /> <remarks />
</Docs> </Docs>
@ -2062,7 +2062,7 @@ class X {
<ReturnType>System.IntPtr</ReturnType> <ReturnType>System.IntPtr</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the indentation level for the widget.</summary>
<returns>a <see cref="T:System.IntPtr" /></returns> <returns>a <see cref="T:System.IntPtr" /></returns>
<remarks /> <remarks />
</Docs> </Docs>

6
doc/en/Gtk/HTMLBeginFlags.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>Flags for how to begin processing a chunk of HTML.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -69,4 +69,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

8
doc/en/Gtk/HTMLClassProperties.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>A properties class for <see cref="T:Gtk.HTML"/>.</summary>
<remarks>To be added</remarks> <remarks>Internal. Do not use.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Opaque</BaseTypeName> <BaseTypeName>GLib.Opaque</BaseTypeName>
@ -20,7 +20,7 @@
<Interface> <Interface>
<InterfaceName>GLib.IWrapper</InterfaceName> <InterfaceName>GLib.IWrapper</InterfaceName>
</Interface> </Interface>
</Interfaces> </Interfaces>
<Attributes /> <Attributes />
<Members> <Members>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -40,4 +40,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

12
doc/en/Gtk/HTMLCommandType.xml
View file

@ -1181,7 +1181,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Move focus forward one widget.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -1194,7 +1194,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Move focus backward one widget.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -1207,7 +1207,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Popup the context menu.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -1545,7 +1545,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Select a paragraph or more.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -1818,7 +1818,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Grab the keyboard focus.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -2006,4 +2006,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

18
doc/en/Gtk/HTMLEditorAPI.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>Hooks for an HTML editor. Currently unsupported in Gtk#.</summary>
<remarks>To be added</remarks> <remarks>See <see cref="M:Gtk.HTML.SetEditorApi"/>.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>An empty object.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="New"> <Member MemberName="New">
@ -41,11 +41,11 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Default constructor.</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param> <param name="raw">A <see cref="T:IntPtr"/>, pointer to the underlying C object.</param>
<returns>To be added: an object of type 'Gtk.HTMLEditorAPI'</returns> <returns>A <see cref="T:Gtk.HTMLEditorAPI"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

6
doc/en/Gtk/HTMLEditorEventType.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>Enumeration of possible kinds of HTML editing events.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -95,4 +95,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

20
doc/en/Gtk/HTMLFontStyleShift.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>Enumeration for how HTML font styles can be changed.</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>Bold font style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -50,7 +50,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Italic font style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -63,7 +63,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Underlined font style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -76,7 +76,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Strikeout font style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -89,7 +89,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Fixed-width font style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -102,7 +102,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Subscript font style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -115,7 +115,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Superscript font style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -134,4 +134,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

32
doc/en/Gtk/HTMLParagraphStyle.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>Enumeration of paragraph styles possible in <see cref="T:Gtk.HTML"/>.</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>Normal style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -50,7 +50,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Header 1 style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -63,7 +63,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Header 2 style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -76,7 +76,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Header 3 style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -89,7 +89,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Header 4 style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -102,7 +102,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Header 5 style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -115,7 +115,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Header 6 style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -128,7 +128,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Email address style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -141,7 +141,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Preformatted text style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -154,7 +154,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Unnumbered list style.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -167,7 +167,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Roman-numeral numbered list.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -180,7 +180,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Arabic-numbered ordered list.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -193,7 +193,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Greek-lettered ordered list.</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -212,4 +212,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

6
doc/en/Gtk/HTMLPrintCallback.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 for printing page framing elements.</summary>
<remarks>To be added</remarks> <remarks>Used to print headers and footers in <see cref="M:Gtk.HTML.PrintWithHeaderFooter"/>.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>
@ -28,4 +28,4 @@
<ReturnValue> <ReturnValue>
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
</Type> </Type>

56
doc/en/Gtk/HTMLStream.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>Handles streaming I/O for <see cref="T:Gtk.HTML"/>.</summary>
<remarks>To be added</remarks> <remarks>TODO: needs examples.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -31,10 +31,10 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="html">To be added: an object of type 'Gtk.HTML'</param> <param name="html">A <see cref="T:Gtk.HTML"/></param>
<param name="stream">To be added: an object of type 'Gtk.HTMLStream'</param> <param name="stream">A <see cref="T:Gtk.HTMLStream"/></param>
<returns>To be added: an object of type 'Gtk.HTMLStream'</returns> <returns>A <see cref="T:Gtk.HTMLStream"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Write"> <Member MemberName="Write">
@ -47,9 +47,9 @@
<Parameter Name="buffer" Type="System.String" /> <Parameter Name="buffer" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Writes the HTML out to <paramref name="buffer"/></summary>
<param name="buffer">To be added: an object of type 'string'</param> <param name="buffer">A <see cref="T:System.String"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Destroy"> <Member MemberName="Destroy">
@ -60,8 +60,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Destroy the stream object and dispose of the memory it uses.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Close"> <Member MemberName="Close">
@ -74,9 +74,9 @@
<Parameter Name="status" Type="Gtk.HTMLStreamStatus" /> <Parameter Name="status" Type="Gtk.HTMLStreamStatus" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Close the stream.</summary>
<param name="status">To be added: an object of type 'Gtk.HTMLStreamStatus'</param> <param name="status">A <see cref="T:Gtk.HTMLStreamStatus"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Vprintf"> <Member MemberName="Vprintf">
@ -91,10 +91,10 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<param name="format">To be added: an object of type 'string'</param> <param name="format">A <see cref="T:System.String"/></param>
<param name="ap">To be added: an object of type 'IntPtr'</param> <param name="ap">A <see cref="T:IntPtr"/></param>
<returns>To be added: an object of type 'int'</returns> <returns>A <see cref="T:System.Int32"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Write"> <Member MemberName="Write">
@ -108,10 +108,10 @@
<Parameter Name="size" Type="System.Int32" /> <Parameter Name="size" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Write the HTML to <paramref name="buffer"/>.</summary>
<param name="buffer">To be added: an object of type 'byte []'</param> <param name="buffer">A <see cref="T:byte []"/></param>
<param name="size">To be added: an object of type 'int'</param> <param name="size">A <see cref="T:System.Int32"/></param>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Types"> <Member MemberName="Types">
@ -122,8 +122,8 @@
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns> <returns>A <see cref="T:System.String"/></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -137,7 +137,7 @@
<summary>To be added</summary> <summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.HTMLStream" /></returns> <returns>a <see cref="T:Gtk.HTMLStream" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -151,14 +151,14 @@
<Parameter Name="close_func" Type="Gtk.HTMLStreamCloseFunc" /> <Parameter Name="close_func" Type="Gtk.HTMLStreamCloseFunc" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor.</summary>
<param name="html">a <see cref="T:Gtk.HTML" /></param> <param name="html">a <see cref="T:Gtk.HTML" /></param>
<param name="type_func">a <see cref="T:Gtk.HTMLStreamTypesFunc" /></param> <param name="type_func">a <see cref="T:Gtk.HTMLStreamTypesFunc" /></param>
<param name="write_func">a <see cref="T:Gtk.HTMLStreamWriteFunc" /></param> <param name="write_func">a <see cref="T:Gtk.HTMLStreamWriteFunc" /></param>
<param name="close_func">a <see cref="T:Gtk.HTMLStreamCloseFunc" /></param> <param name="close_func">a <see cref="T:Gtk.HTMLStreamCloseFunc" /></param>
<returns>a <see cref="T:Gtk.HTMLStream" /></returns> <returns>a <see cref="T:Gtk.HTMLStream" /></returns>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

6
doc/en/Gtk/HTMLStreamCloseFunc.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>A delegate for use with <see cref="T:Gtk.HTMLStream"/>. Meant to be used for closing the stream.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>
@ -30,4 +30,4 @@
<ReturnValue> <ReturnValue>
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
</Type> </Type>

13
doc/en/Gtk/HTMLStreamStatus.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>An enumeration of possible statuses for an HTML stream.</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>Okay; HTTP result 200</summary>
<remarks> <remarks>
</remarks> </remarks>
</Docs> </Docs>
@ -50,9 +50,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Not okay.</summary>
<remarks> <remarks>
</remarks> (TODO: This is for everything non-200? Look up in source.)
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="value__"> <Member MemberName="value__">
@ -69,4 +70,4 @@
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
</Type> </Type>

6
doc/en/Gtk/HTMLStreamTypesFunc.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>A delegate for use with <see cref="T:Gtk.HTMLStream"/>.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>
@ -29,4 +29,4 @@
<ReturnValue> <ReturnValue>
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
</Type> </Type>

6
doc/en/Gtk/HTMLStreamWriteFunc.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>A delegate for use with <see cref="T:Gtk.HTMLStream"/>. Meant to be used for writing the stream.</summary>
<remarks>To be added</remarks> <remarks/>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Delegate</BaseTypeName> <BaseTypeName>System.Delegate</BaseTypeName>
@ -31,4 +31,4 @@
<ReturnValue> <ReturnValue>
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
</Type> </Type>