X-Git-Url: http://wien.tomnetworks.com/gitweb/?a=blobdiff_plain;f=web%2Fdocumentation;h=40085e851267d8d531235348427d9044e53fa07f;hb=feca28835d4e3cb2be67bdcbd4f54fee62c3797a;hp=4bf6aab6760bfa5b8480486d7b207e2c1caf90ce;hpb=3ef3b0d330ed4188bea7ee1e305ae3c9097fa516;p=mono.git
diff --git a/web/documentation b/web/documentation
index 4bf6aab6760..40085e85126 100644
--- a/web/documentation
+++ b/web/documentation
@@ -25,7 +25,11 @@
libraries as well as the class libraries produced by
the project).
- * Tutorials on Mono and the specifics of running it.
+ * Tutorials on Mono and the specifics of running it
+ (The Mono
+ Hispano team has produced lots of tutorials
+ in spanish
* A guide to Mono as compared to the Microsoft.NET
Framework SDK
@@ -55,7 +59,7 @@
repository (on gtk-sharp/doc) and we need volunteers to help
populate the documentation for it. Since Gtk# is a wrapper
for Gtk, plenty of documentation exists in the Gnome developer
+ href="http://developer.gnome.org/doc/API">Gnome developer
site.
To get started:
@@ -110,18 +114,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>
+
+<para> </para>
Used to separate paragraphs.
- <paramref name="param_name"/>
+<paramref name="param_name"/>
Used to reference a formal parameter to a function.
- <see cref="T:SomeTypeName"/>
+<see cref="T:SomeTypeName"/>
Use this to reference a type, this will include an hyper
link to the page for type SomeTypeName.
@@ -129,11 +133,11 @@ _Pre_
For example, to reference "System.Enum", do:
- <see cref="T:System.Enum"/>
+ <see cref="T:System.Enum"/>
- <see cref="P:SomeTypeName.Property"/>
+<see cref="P:SomeTypeName.Property"/>
Use this to reference a property, this will include an hyper
link to the page for the property `Property' of type `SomeTypeName'.
@@ -141,11 +145,11 @@ _Pre_
For example, to reference the BaseType property in System.Type, do:
- <see cref="P:System.Type.BaseType"/>
+ <see cref="P:System.Type.BaseType"/>
- <see cref="M:SomeTypeName.Method(type,type)"/>
+<see cref="M:SomeTypeName.Method(type,type)"/>
Use this to reference a method, this will include an hyper
link to the page for the method `Method' of type `SomeTypeName'.
@@ -153,27 +157,27 @@ _Pre_
For example, to reference the ToString method in System.Object, do:
- <see cref="M:System.Object.ToString()"/>
+ <see cref="M:System.Object.ToString()"/>
- <see langword="keywrod"/>
+<see langword="keyword"/>
Use this to link to a keyword in the C# language, for
example to link to `true', do:
- <see langword="true"/>
+ <see langword="true"/>
- <example> ... </example>
+<example> ... </example>
Use example to insert an example. The example can
contain explanatory text and code.
- <code lang="C#">.. </code>
+<code lang="C#">.. </code>
Use this to provide a sample C# program, typically used
@@ -187,38 +191,38 @@ _Pre_
You can link to an example like this:
- <code lang="C#" source="file.cs"> </code>
+ <code lang="C#" source="file.cs"> </code>
- <item>
+<item>
- <list type="bullet"> </list>
+<list type="bullet"> </list>
Use this to create lists. Lists contains <item>
- elements
+ elements which have to contain <term> containers.
- <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>
For two-column tables. Inside use:
- <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>
** Words of warning.
@@ -246,6 +250,11 @@ _Pre_
please don't open the Microsoft docs and refer to them for each member
you document.
+ The best way of documenting is to read our source code
+ implementation and explain in your own words what our implementation
+ does, and what the user can do with it.
+
There's a lot of domain expertise among the class library contributors;
let's put the same personal stamp on the class library documentation
- that we have on the class libraries themselves.
\ No newline at end of file
+ that we have on the class libraries themselves.
+