diff options
Diffstat (limited to 'web')
-rw-r--r-- | web/documentation | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/web/documentation b/web/documentation index 4bf6aab6760..2d207003e58 100644 --- a/web/documentation +++ b/web/documentation @@ -110,18 +110,18 @@ As you document Gtk# you will have a number of tags that you can use inside the summary and remarks sections, these are: -_Pre_ - <para> </para> +<pre> +<para> </para> </pre> Used to separate paragraphs. <pre> - <paramref name="param_name"/> +<paramref name="param_name"/> </pre> Used to reference a formal parameter to a function. <pre> - <see cref="T:SomeTypeName"/> +<see cref="T:SomeTypeName"/> </pre> Use this to reference a type, this will include an hyper link to the page for type SomeTypeName. @@ -129,11 +129,11 @@ _Pre_ For example, to reference "System.Enum", do: <pre> - <see cref="T:System.Enum"/> + <see cref="T:System.Enum"/> </pre> <pre> - <see cref="P:SomeTypeName.Property"/> +<see cref="P:SomeTypeName.Property"/> </pre> Use this to reference a property, this will include an hyper link to the page for the property `Property' of type `SomeTypeName'. @@ -141,11 +141,11 @@ _Pre_ For example, to reference the BaseType property in System.Type, do: <pre> - <see cref="P:System.Type.BaseType"/> + <see cref="P:System.Type.BaseType"/> </pre> <pre> - <see cref="M:SomeTypeName.Method(type,type)"/> +<see cref="M:SomeTypeName.Method(type,type)"/> </pre> Use this to reference a method, this will include an hyper link to the page for the method `Method' of type `SomeTypeName'. @@ -153,27 +153,27 @@ _Pre_ For example, to reference the ToString method in System.Object, do: <pre> - <see cref="M:System.Object.ToString()"/> + <see cref="M:System.Object.ToString()"/> </pre> <pre> - <see langword="keywrod"/> +<see langword="keyword"/> </pre> Use this to link to a keyword in the C# language, for example to link to `true', do: <pre> - <see langword="true"/> + <see langword="true"/> </pre> <pre> - <example> ... </example> +<example> ... </example> </pre> Use example to insert an example. The example can contain explanatory text and code. <pre> - <code lang="C#">.. </code> +<code lang="C#">.. </code> </pre> Use this to provide a sample C# program, typically used @@ -187,38 +187,38 @@ _Pre_ You can link to an example like this: <pre> - <code lang="C#" source="file.cs"> </code> + <code lang="C#" source="file.cs"> </code> </pre> <pre> - <item> +<item> </pre> <pre> - <list type="bullet"> </list> +<list type="bullet"> </list> </pre> Use this to create lists. Lists contains <item> elements <pre> - <list type="table"> </lits> - <listheader> - <term>YOUR FIRST COLUMN</term> - <description>YOUR DESCRIPTION</description> - </listheader> +<list type="table"> </lits> + <listheader> + <term>YOUR FIRST COLUMN</term> + <description>YOUR DESCRIPTION</description> + </listheader> </pre> For two-column tables. Inside use: <pre> - <item> - <term>First</term> - <description>First descritpion</description> - </item> - <item> - <term>Second</term> - <description>Second descirption</description> - </item> +<item> + <term>First</term> + <description>First descritpion</description> +</item> +<item> + <term>Second</term> + <description>Second descirption</description> +</item> </pre> ** Words of warning. |