Click here to Skip to main content
15,892,005 members
Articles / Programming Languages / C#

ADB - Documentation Compiler for Managed Class Libraries

Rate me:
Please Sign up or sign in to vote.
4.60/5 (4 votes)
8 Mar 2009CPOL1 min read 30.8K   834   29  
ADB produces MSDN style documentation by reflecting and integrating XML Documentation Comments.
<?xml version="1.0" encoding="utf-8"?>
<root>
  <!-- 
    Microsoft ResX Schema 
    
    Version 2.0
    
    The primary goals of this format is to allow a simple XML format 
    that is mostly human readable. The generation and parsing of the 
    various data types are done through the TypeConverter classes 
    associated with the data types.
    
    Example:
    
    ... ado.net/XML headers & schema ...
    <resheader name="resmimetype">text/microsoft-resx</resheader>
    <resheader name="version">2.0</resheader>
    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
        <value>[base64 mime encoded serialized .NET Framework object]</value>
    </data>
    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
        <comment>This is a comment</comment>
    </data>
                
    There are any number of "resheader" rows that contain simple 
    name/value pairs.
    
    Each data row contains a name, and value. The row also contains a 
    type or mimetype. Type corresponds to a .NET class that support 
    text/value conversion through the TypeConverter architecture. 
    Classes that don't support this are serialized and stored with the 
    mimetype set.
    
    The mimetype is used for serialized objects, and tells the 
    ResXResourceReader how to depersist the object. This is currently not 
    extensible. For a given mimetype the value must be set accordingly:
    
    Note - application/x-microsoft.net.object.binary.base64 is the format 
    that the ResXResourceWriter will generate, however the reader can 
    read any of the formats listed below.
    
    mimetype: application/x-microsoft.net.object.binary.base64
    value   : The object must be serialized with 
            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
            : and then encoded with base64 encoding.
    
    mimetype: application/x-microsoft.net.object.soap.base64
    value   : The object must be serialized with 
            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
            : and then encoded with base64 encoding.

    mimetype: application/x-microsoft.net.object.bytearray.base64
    value   : The object must be serialized into a byte array 
            : using a System.ComponentModel.TypeConverter
            : and then encoded with base64 encoding.
    -->
  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
    <xsd:element name="root" msdata:IsDataSet="true">
      <xsd:complexType>
        <xsd:choice maxOccurs="unbounded">
          <xsd:element name="metadata">
            <xsd:complexType>
              <xsd:sequence>
                <xsd:element name="value" type="xsd:string" minOccurs="0" />
              </xsd:sequence>
              <xsd:attribute name="name" use="required" type="xsd:string" />
              <xsd:attribute name="type" type="xsd:string" />
              <xsd:attribute name="mimetype" type="xsd:string" />
              <xsd:attribute ref="xml:space" />
            </xsd:complexType>
          </xsd:element>
          <xsd:element name="assembly">
            <xsd:complexType>
              <xsd:attribute name="alias" type="xsd:string" />
              <xsd:attribute name="name" type="xsd:string" />
            </xsd:complexType>
          </xsd:element>
          <xsd:element name="data">
            <xsd:complexType>
              <xsd:sequence>
                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
              </xsd:sequence>
              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
              <xsd:attribute ref="xml:space" />
            </xsd:complexType>
          </xsd:element>
          <xsd:element name="resheader">
            <xsd:complexType>
              <xsd:sequence>
                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
              </xsd:sequence>
              <xsd:attribute name="name" type="xsd:string" use="required" />
            </xsd:complexType>
          </xsd:element>
        </xsd:choice>
      </xsd:complexType>
    </xsd:element>
  </xsd:schema>
  <resheader name="resmimetype">
    <value>text/microsoft-resx</value>
  </resheader>
  <resheader name="version">
    <value>2.0</value>
  </resheader>
  <resheader name="reader">
    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <resheader name="writer">
    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <data name="E" xml:space="preserve">
    <value>E_</value>
  </data>
  <data name="Extension" xml:space="preserve">
    <value>.html</value>
  </data>
  <data name="F" xml:space="preserve">
    <value>F_</value>
  </data>
  <data name="M" xml:space="preserve">
    <value>M_</value>
  </data>
  <data name="P" xml:space="preserve">
    <value>P_</value>
  </data>
  <data name="strClass" xml:space="preserve">
    <value>class</value>
  </data>
  <data name="strConstructor" xml:space="preserve">
    <value>constructor</value>
  </data>
  <data name="strDefault" xml:space="preserve">
    <value>CHM Document(Default)</value>
  </data>
  <data name="strDelegate" xml:space="preserve">
    <value>delegate</value>
  </data>
  <data name="strEnumeration" xml:space="preserve">
    <value>enumeration</value>
  </data>
  <data name="strError" xml:space="preserve">
    <value>error</value>
  </data>
  <data name="strEvent" xml:space="preserve">
    <value>event</value>
  </data>
  <data name="strField" xml:space="preserve">
    <value>field</value>
  </data>
  <data name="strIndex" xml:space="preserve">
    <value>Index</value>
  </data>
  <data name="String" xml:space="preserve">
    <value>Templates</value>
  </data>
  <data name="String01" xml:space="preserve">
    <value>public class</value>
  </data>
  <data name="String02" xml:space="preserve">
    <value>nonpublic class</value>
  </data>
  <data name="String03" xml:space="preserve">
    <value>type</value>
  </data>
  <data name="String04" xml:space="preserve">
    <value>inherited members</value>
  </data>
  <data name="String05" xml:space="preserve">
    <value>members</value>
  </data>
  <data name="String1" xml:space="preserve">
    <value>anthor operation is running</value>
  </data>
  <data name="String16" xml:space="preserve">
    <value>assembly</value>
  </data>
  <data name="String17" xml:space="preserve">
    <value>assembly(*.dll,*.exe)|*.dll;*.exe</value>
  </data>
  <data name="String18" xml:space="preserve">
    <value>XML文件(*.xml)|*.xml</value>
  </data>
  <data name="String19" xml:space="preserve">
    <value>Are you sure to delete assembly</value>
  </data>
  <data name="String20" xml:space="preserve">
    <value>Tip</value>
  </data>
  <data name="String21" xml:space="preserve">
    <value>All Assemblies</value>
  </data>
  <data name="String22" xml:space="preserve">
    <value>All Types</value>
  </data>
  <data name="String23" xml:space="preserve">
    <value>Document Builder</value>
  </data>
  <data name="String24" xml:space="preserve">
    <value>Quick Select</value>
  </data>
  <data name="String25" xml:space="preserve">
    <value>Delete</value>
  </data>
  <data name="String26" xml:space="preserve">
    <value>Add</value>
  </data>
  <data name="String27" xml:space="preserve">
    <value>Delete</value>
  </data>
  <data name="String28" xml:space="preserve">
    <value>Add</value>
  </data>
  <data name="String29" xml:space="preserve">
    <value>Title</value>
  </data>
  <data name="String30" xml:space="preserve">
    <value>Build as</value>
  </data>
  <data name="String31" xml:space="preserve">
    <value>Default</value>
  </data>
  <data name="String32" xml:space="preserve">
    <value>Assembly</value>
  </data>
  <data name="String33" xml:space="preserve">
    <value>XML Document</value>
  </data>
  <data name="String34" xml:space="preserve">
    <value>Build</value>
  </data>
  <data name="String35" xml:space="preserve">
    <value>OK</value>
  </data>
  <data name="String36" xml:space="preserve">
    <value>Quick Select</value>
  </data>
  <data name="String42" xml:space="preserve">
    <value>Remarks</value>
  </data>
  <data name="String43" xml:space="preserve">
    <value>Examples</value>
  </data>
  <data name="String44" xml:space="preserve">
    <value>Syntax</value>
  </data>
  <data name="String45" xml:space="preserve">
    <value>Exception</value>
  </data>
  <data name="String46" xml:space="preserve">
    <value>Paremeters</value>
  </data>
  <data name="String47" xml:space="preserve">
    <value>Return</value>
  </data>
  <data name="String48" xml:space="preserve">
    <value>Value</value>
  </data>
  <data name="String49" xml:space="preserve">
    <value>Restart will be available!</value>
  </data>
  <data name="String50" xml:space="preserve">
    <value>Open file?</value>
  </data>
  <data name="String51" xml:space="preserve">
    <value>Input title</value>
  </data>
  <data name="String52" xml:space="preserve">
    <value>Assembly has been added!</value>
  </data>
  <data name="String53" xml:space="preserve">
    <value>XML document has been added!</value>
  </data>
  <data name="String55" xml:space="preserve">
    <value>Ary you sure to cancle?</value>
  </data>
  <data name="String56" xml:space="preserve">
    <value>(Inherit from {0})</value>
  </data>
  <data name="strInterface" xml:space="preserve">
    <value>interface</value>
  </data>
  <data name="strMethod" xml:space="preserve">
    <value>method</value>
  </data>
  <data name="strNamespace" xml:space="preserve">
    <value>namespace</value>
  </data>
  <data name="strPrivateField" xml:space="preserve">
    <value>Private field</value>
  </data>
  <data name="strPrivateMethod" xml:space="preserve">
    <value>Private method</value>
  </data>
  <data name="strPrivateProperty" xml:space="preserve">
    <value>Private property</value>
  </data>
  <data name="strProperty" xml:space="preserve">
    <value>Property</value>
  </data>
  <data name="strProtectedField" xml:space="preserve">
    <value>Protected field</value>
  </data>
  <data name="strProtectedMethod" xml:space="preserve">
    <value>Protected method</value>
  </data>
  <data name="strProtectedProperty" xml:space="preserve">
    <value>Protected property</value>
  </data>
  <data name="strPublicField" xml:space="preserve">
    <value>Public field</value>
  </data>
  <data name="strPublicMethod" xml:space="preserve">
    <value>Public method</value>
  </data>
  <data name="strPublicProperty" xml:space="preserve">
    <value>Public property</value>
  </data>
  <data name="strStructure" xml:space="preserve">
    <value>Structure</value>
  </data>
  <data name="strTip" xml:space="preserve">
    <value>Tip</value>
  </data>
  <data name="T" xml:space="preserve">
    <value>T_</value>
  </data>
</root>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer
China China
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions