[Mono-docs-list] Updating class library docs

Hector E. Gomez Morales hgomez_36@flashmail.com
Thu, 04 Mar 2004 20:26:55 -0600


One question is that style of indentation in the docs intentional?
because the ECMA docs and the Mono Docs use a 2 space indentation.
mainly because is more readable and tries to maintain the wrapping of
the lines to a minimum.
(mainly because the Indentation property has a default of 2 IndentChars
for each level).

Oh I see that it was intentional (from stub.cs):

        private static void WriteXml(XmlElement element,
System.IO.TextWriter output) {
                XmlTextWriter writer = new XmlTextWriter(output);
                writer.Formatting = Formatting.Indented; //this one fine
                writer.Indentation = 1;  //should be 2
                writer.IndentChar = '\t'; //should be space
                element.WriteTo(writer);
                output.WriteLine();
        }

First please the docs don't use tab for the IdentChar it uses space,
second from Microsoft documentation:

To ensure valid XML, you must specify a valid whitespace character, 0x9,
0x10, 0x13 or 0x20.

On Thu, 2004-03-04 at 15:17, Joshua Tauberer wrote:
> Miguel de Icaza wrote:
> > Please apply your new patches to CVS.
> 
> Done.
> 
> Just as a correction to myself, actually two documented methods were 
> initially lost: System/Math.xml DivRem (two overloads).  The problem was 
> they had the wrong parameter types for out parameters (lacking the & at 
> the end and the RefType attribute).  I corrected this before committing.