projects / mono.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
update known-issues
[mono.git] / web / documentation
diff --git a/web/documentation b/web/documentation
index 4bf6aab6760bfa5b8480486d7b207e2c1caf90ce..40085e851267d8d531235348427d9044e53fa07f 100644 (file)
--- a/web/documentation
+++ b/web/documentation
@@ -25,7 +25,11 @@
                  libraries as well as the class libraries produced by
                  the project).
 
                  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 <a href="http://www.monohispano.org">Mono
+                 Hispano</a> team has produced lots of <a
+                 href="http://www.monohispano.org/tutoriales.php">tutorials
+                 in spanish</a>
 
                * A guide to Mono as compared to the Microsoft.NET
                  Framework SDK
 
                * 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 <a
        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 <a
-       href="http://developer.gnome.org/doc/API/2.0/">Gnome developer
+       href="http://developer.gnome.org/doc/API">Gnome developer
        site</a>.
 
        To get started:
        site</a>.
 
        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:
 
         As you document Gtk# you will have a number of tags that you can
         use inside the summary and remarks sections, these are:
 
-_Pre_        
-        &lt;para&gt; &lt;/para&gt;
+<pre>        
+&lt;para&gt; &lt;/para&gt;
 </pre>
                Used to separate paragraphs.
       
 <pre>  
 </pre>
                Used to separate paragraphs.
       
 <pre>  
-        &lt;paramref name="param_name"/&gt;
+&lt;paramref name="param_name"/&gt;
 </pre>
                Used to reference a formal parameter to a function.
 
 <pre>  
 </pre>
                Used to reference a formal parameter to a function.
 
 <pre>  
-        &lt;see cref="T:SomeTypeName"/&gt;
+&lt;see cref="T:SomeTypeName"/&gt;
 </pre>
                Use this to reference a type, this will include an hyper
                link to the page for type SomeTypeName.
 </pre>
                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:
         
 <pre>
                For example, to reference "System.Enum", do:
         
 <pre>
-               &lt;see cref="T:System.Enum"/&gt;
+       &lt;see cref="T:System.Enum"/&gt;
 </pre>
 
 <pre>
 </pre>
 
 <pre>
-        &lt;see cref="P:SomeTypeName.Property"/&gt;
+&lt;see cref="P:SomeTypeName.Property"/&gt;
 </pre>
                Use this to reference a property, this will include an hyper
                link to the page for the property `Property' of type `SomeTypeName'.
 </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 +145,11 @@ _Pre_
                For example, to reference the BaseType property in System.Type, do:
         
 <pre>
                For example, to reference the BaseType property in System.Type, do:
         
 <pre>
-               &lt;see cref="P:System.Type.BaseType"/&gt;
+       &lt;see cref="P:System.Type.BaseType"/&gt;
 </pre>
 
 <pre>
 </pre>
 
 <pre>
-        &lt;see cref="M:SomeTypeName.Method(type,type)"/&gt;
+&lt;see cref="M:SomeTypeName.Method(type,type)"/&gt;
 </pre>
                Use this to reference a method, this will include an hyper
                link to the page for the method `Method' of type `SomeTypeName'.
 </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 +157,27 @@ _Pre_
                For example, to reference the ToString method in System.Object, do:
         
 <pre>
                For example, to reference the ToString method in System.Object, do:
         
 <pre>
-               &lt;see cref="M:System.Object.ToString()"/&gt;
+       &lt;see cref="M:System.Object.ToString()"/&gt;
 </pre>
         
 <pre>
 </pre>
         
 <pre>
-        &lt;see langword="keywrod"/&gt;
+&lt;see langword="keyword"/&gt;
 </pre>
                Use this to link to a keyword in the C# language, for
                example to link to `true', do:
 
 <pre>
 </pre>
                Use this to link to a keyword in the C# language, for
                example to link to `true', do:
 
 <pre>
-                       &lt;see langword="true"/&gt;
+       &lt;see langword="true"/&gt;
 </pre>
         
 <pre>
 </pre>
         
 <pre>
-        &lt;example&gt; ... &lt;/example&gt;
+&lt;example&gt; ... &lt;/example&gt;
 </pre>        
                Use example to insert an example.  The example can 
                contain explanatory text and code.
         
 <pre>
 </pre>        
                Use example to insert an example.  The example can 
                contain explanatory text and code.
         
 <pre>
-        &lt;code lang="C#"&gt;.. &lt;/code&gt;
+&lt;code lang="C#"&gt;.. &lt;/code&gt;
 </pre>
         
                Use this to provide a sample C# program, typically used
 </pre>
         
                Use this to provide a sample C# program, typically used
@@ -187,38 +191,38 @@ _Pre_
                You can link to an example like this:
 
 <pre>
                You can link to an example like this:
 
 <pre>
-               &lt;code lang="C#" source="file.cs"&gt; &lt;/code&gt;
+       &lt;code lang="C#" source="file.cs"&gt; &lt;/code&gt;
 </pre>
 
 <pre>
 </pre>
 
 <pre>
-        &lt;item&gt;
+&lt;item&gt;
 </pre>
                
 <pre>
 </pre>
                
 <pre>
-        &lt;list type="bullet"&gt;  &lt;/list&gt;
+&lt;list type="bullet"&gt;  &lt;/list&gt;
 </pre>
         
                Use this to create lists.  Lists contains &lt;item&gt;
 </pre>
         
                Use this to create lists.  Lists contains &lt;item&gt;
-               elements
+               elements which have to contain &lt;term&gt; containers.
         
 <pre>
         
 <pre>
-        &lt;list type="table"&gt; &lt;/lits&gt;
-                    &lt;listheader&gt;
-                      &lt;term&gt;YOUR FIRST COLUMN&lt;/term&gt;
-                      &lt;description&gt;YOUR DESCRIPTION&lt;/description&gt;
-                    &lt;/listheader&gt;
+&lt;list type="table"&gt; &lt;/lits&gt;
+            &lt;listheader&gt;
+              &lt;term&gt;YOUR FIRST COLUMN&lt;/term&gt;
+              &lt;description&gt;YOUR DESCRIPTION&lt;/description&gt;
+            &lt;/listheader&gt;
 </pre>
                For two-column tables.  Inside use:
         
 <pre>
 </pre>
                For two-column tables.  Inside use:
         
 <pre>
-               &lt;item&gt;
-                       &lt;term&gt;First&lt;/term&gt;
-                       &lt;description&gt;First descritpion&lt;/description&gt;
-               &lt;/item&gt;
-               &lt;item&gt;
-                       &lt;term&gt;Second&lt;/term&gt;
-                       &lt;description&gt;Second descirption&lt;/description&gt;
-               &lt;/item&gt;
+&lt;item&gt;
+       &lt;term&gt;First&lt;/term&gt;
+       &lt;description&gt;First descritpion&lt;/description&gt;
+&lt;/item&gt;
+&lt;item&gt;
+       &lt;term&gt;Second&lt;/term&gt;
+       &lt;description&gt;Second descirption&lt;/description&gt;
+&lt;/item&gt;
 </pre>
 
 ** Words of warning.
 </pre>
 
 ** Words of warning.
@@ -246,6 +250,11 @@ _Pre_
         please don't open the Microsoft docs and refer to them for each member
         you document.
 
         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
         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.
+
my mono mirror. check out Moved to http://github.com/mono/mono