home *** CD-ROM | disk | FTP | other *** search
/ Chip 2005 February / CMCD0205.ISO / Software / Freeware / Programare / Sharp / SharpDevelop_1.0.3.1761_Setup.exe / NDoc.Documenter.LinearHtml.xml < prev    next >
Extensible Markup Language  |  2004-12-20  |  33KB  |  583 lines
  1. <?xml version="1.0"?>
  2. <doc>
  3.     <assembly>
  4.         <name>NDoc.Documenter.LinearHtml</name>
  5.     </assembly>
  6.     <members>
  7.         <member name="T:NDoc.Documenter.LinearHtml.LhExternalHtmlProvider">
  8.             <summary>
  9.             Used as an extension object to the xslt processor to allow
  10.             retrieving user-provided raw html.
  11.             </summary>
  12.         </member>
  13.         <member name="M:NDoc.Documenter.LinearHtml.LhExternalHtmlProvider.#ctor(NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig,System.String)">
  14.             <summary>
  15.             Contructor.
  16.             </summary>
  17.             <param name="config">LinearHtmlDocumenterConfig from which the property values can be retrieved.</param>
  18.             <param name="fileName">Name of the HTML file that is currently being generated by the xslt processor.</param>
  19.         </member>
  20.         <member name="M:NDoc.Documenter.LinearHtml.LhExternalHtmlProvider.GetHeaderHtml(System.String)">
  21.             <summary>
  22.             Retrieves user-provided raw html to use as page headers.
  23.             </summary>
  24.             <param name="topicTitle">The title of the current topic.</param>
  25.             <returns></returns>
  26.         </member>
  27.         <member name="M:NDoc.Documenter.LinearHtml.LhExternalHtmlProvider.GetFooterHtml(System.String,System.String,System.String)">
  28.             <summary>
  29.             Retrieves user-provided raw html to use as page footers.
  30.             </summary>
  31.             <param name="assemblyName">The name of the assembly for the current topic.</param>
  32.             <param name="assemblyVersion">The version of the assembly for the current topic.</param>
  33.             <param name="topicTitle">The title of the current topic.</param>
  34.             <returns></returns>
  35.         </member>
  36.         <member name="T:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter">
  37.             <summary>
  38.             This creates a linear (serial, more printable) html file from an ndoc xml file. 
  39.             This was designed and implemented with the intention that the html will be
  40.             inserted into a Word document, but this could be useful for other scenarios.
  41.             </summary>
  42.             <remarks>
  43.             <para><pre>
  44.             The document produced is organized as follows:
  45.                Namespaces List: a section listing namespaces and which assembly 
  46.                   they're from, and optionally their namespace summaries.
  47.                Namespace: a section for each namespace
  48.                     Types List: a list of classes, interfaces, etc in the 
  49.                         namespace, with their summaries.
  50.                     Type: Classes
  51.                     Type: Interfaces
  52.                     Type: Enumerations
  53.                     Type: Structs
  54.                     Type: Delegates
  55.             </pre></para>
  56.             <para>
  57.             This class uses C#'s xml processing capabilities rather than xslt.
  58.             This was more or less an experiment, and I'm not sure whether this
  59.             is better than an xslt implementation or not.  The complexity might
  60.             be similar, but I expect this implementation to be many times faster
  61.             than an equivalent xslt implementation.
  62.             </para>
  63.             <para>
  64.             This class writes a single linear html file, but traverses the xml
  65.             document pretty much just once.  To do this, multiple XmlTextWriters
  66.             are create such that they can be written to in any order.  Then at
  67.             the end the memory buffers written by each text writer are copied
  68.             to the output file in the appropriate order.
  69.             </para> 
  70.             <para>This has a Main for easier and faster test runs outside of NDoc.</para>
  71.             </remarks>
  72.         </member>
  73.         <member name="F:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.xPathNavigator">
  74.             <summary>The main navigator which keeps track of where we
  75.             are in the document.</summary>
  76.         </member>
  77.         <member name="F:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.namespaceListWriter">
  78.             <summary>Writer for the first section, the namespace list.</summary>
  79.         </member>
  80.         <member name="F:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.namespaceWriters">
  81.             <summary>A hashtable from namespace name to Hashtables which
  82.             go from section name (Classes, Interfaces, etc) to XmlTextWriters
  83.             for that section.</summary>
  84.         </member>
  85.         <member name="F:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.namespaceSections">
  86.             <summary>Hashtable from xml node name to section name. For example
  87.             class to Classes.</summary>
  88.         </member>
  89.         <member name="F:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.orderedNamespaceSections">
  90.             <summary>
  91.             The namespace sections in the order they will be emitted.
  92.             </summary>
  93.         </member>
  94.         <member name="F:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.orderedMemberTypes">
  95.             <summary>
  96.             A list of Type (class, interface) member types, to specify
  97.             the order in which they should be rendered.
  98.             </summary>
  99.         </member>
  100.         <member name="F:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.typeTransform">
  101.             <summary>This transform can be used for each type. This is incomplete.</summary>
  102.         </member>
  103.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.#ctor">
  104.             <summary>
  105.             Default constructor.
  106.             </summary>
  107.         </member>
  108.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.Clear">
  109.             <summary>See <see cref="T:NDoc.Core.IDocumenter"/>.</summary>
  110.         </member>
  111.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.Load(System.String)">
  112.             <summary>
  113.             Load the specified NDoc Xml file into this object's memory.
  114.             This is useful when this class is used outside of the context of NDoc.
  115.             </summary>
  116.             <param name="fileName">The NDoc Xml file to load.</param>
  117.             <returns>bool - always true</returns>
  118.         </member>
  119.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.Load(System.IO.Stream)">
  120.             <summary>
  121.             Load the specified NDoc Xml into this object's memory.
  122.             This is useful when this class is used outside of the context of NDoc.
  123.             </summary>
  124.             <param name="s">The stream to load.</param>
  125.             <returns>bool - always true</returns>
  126.         </member>
  127.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.CanBuild(NDoc.Core.Project,System.Boolean)">
  128.             <summary>See <see cref="T:NDoc.Core.IDocumenter"/>.</summary>
  129.         </member>
  130.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.Build(NDoc.Core.Project)">
  131.             <summary>See <see cref="T:NDoc.Core.IDocumenter"/>.</summary>
  132.         </member>
  133.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.StartWriters">
  134.             <summary>
  135.             Setup any text writers.
  136.             </summary>
  137.             <returns></returns>
  138.         </member>
  139.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.EndWriters">
  140.             <summary>
  141.             Do whatever is neccesary to any writers before emitting html.
  142.             </summary>
  143.             <returns></returns>
  144.         </member>
  145.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.DeleteWriters">
  146.             <summary>
  147.             Close all writers.  They need to be re-created for the next build.
  148.             </summary>
  149.             <returns></returns>
  150.         </member>
  151.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.StartNamespaceSectionWriter(System.String,System.String)">
  152.             <summary>
  153.             Create a namespace section writer if one doesn't already exist
  154.             for the specified namespace and section.
  155.             </summary>
  156.             <param name="namespaceName">C# namespace name, not xml namespace.</param>
  157.             <param name="sectionName">The section name, such as Classes.</param>
  158.         </member>
  159.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.ToSimpleType(System.String)">
  160.             <summary>
  161.             Convert a full type name like System.Int32 to the more simple version
  162.             "int".
  163.             </summary>
  164.             <param name="s"></param>
  165.             <returns></returns>
  166.         </member>
  167.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.ToAccessDeclaration(System.String)">
  168.             <summary>
  169.             Convert an access string as in the xml (Public, Family, etc) to
  170.             one like we want for declarations (public, protected, etc).
  171.             </summary>
  172.             <param name="typeAccess"></param>
  173.             <returns></returns>
  174.         </member>
  175.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.TypeBaseName(System.String)">
  176.             <summary>
  177.             Return the base of the input type name.  For example the base of 
  178.             System.String is String.
  179.             </summary>
  180.             <param name="typeName"></param>
  181.             <returns></returns>
  182.         </member>
  183.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.GetChildren(System.Xml.XPath.XPathNavigator,System.String)">
  184.             <summary>
  185.             Get the children of the current node which have the specified
  186.             localName.  
  187.             </summary>
  188.             <remarks>
  189.             This is motivated by the fact that XPathNavigator.SelectChildren()
  190.             apparently looks at all descendants.
  191.             </remarks>
  192.             <param name="localName">The localname to select.</param>
  193.             <param name="nav">The XPathNavigator.</param>
  194.             <returns>A new ArrayList of XPathNavigators.</returns>
  195.         </member>
  196.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.GetDescendants(System.Xml.XPath.XPathNavigator,System.String)">
  197.             <summary>
  198.             Get the descendants of the current node which have the specified
  199.             localName.  This just provides a different iteration style
  200.             from XPathNavigator.SelectDescendants().
  201.             </summary>
  202.             <param name="localName">The localname to select.</param>
  203.             <param name="nav">The XPathNavigator.</param>
  204.             <returns>A new ArrayList of XPathNavigators.</returns>
  205.         </member>
  206.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.GetSortedChildren(System.Xml.XPath.XPathNavigator,System.String,System.String)">
  207.             <summary>
  208.             Returns a SortedList which links each child node's attribute value (sorted, of course)
  209.             to an XPathNavigator pointing to that node. This selects child nodes
  210.             based on node local name.  This just looks at immediate children, not
  211.             all descendants.
  212.             </summary>
  213.             <remarks>
  214.             Surprisingly, XPathNavigator.SelectChildren() apparently visits all
  215.             descendants, despite the presence of XPathNavigator.SelectDescendants().
  216.             </remarks>
  217.             <param name="attrName">The attribute to sort on.</param>
  218.             <param name="nav">The parent of the children to index.</param>
  219.             <param name="localName">The localName of child nodes to select.</param>
  220.             <returns>The SortedList of child node attribute values to 
  221.             XPathNavigators.</returns>
  222.         </member>
  223.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.FixCodeNodes(System.Xml.XmlNode)">
  224.             <summary>
  225.             Fix code node such that it will be rendered correctly (using pre).
  226.             </summary>
  227.             <param name="topNode"></param>
  228.         </member>
  229.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.FixCodeNodes(System.Xml.XPath.XPathNavigator)">
  230.             <summary>
  231.             Fix code node such that it will be rendered correctly (using pre).
  232.             </summary>
  233.         </member>
  234.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.GetNodeXmlFixCode(System.Xml.XPath.XPathNavigator)">
  235.             <summary>
  236.             Fix any code nodes under the specified navigator, and return the node's
  237.             inner Xml. 
  238.             </summary>
  239.             <param name="nav"></param>
  240.             <returns></returns>
  241.         </member>
  242.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.GetDescendantNodeWithName(System.Xml.XPath.XPathNavigator,System.String)">
  243.             <summary>
  244.             Return a new XPathNavigator pointing to the first descendant node
  245.             with the specified name.
  246.             </summary>
  247.             <param name="nodeName">The node name string.</param>
  248.             <param name="startNavigator">Initial node to start search from.</param>
  249.             <returns>An XPathNavigator pointing to the specified descendant, or null
  250.             for not found.</returns>
  251.         </member>
  252.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.GetChildNodeWithName(System.Xml.XPath.XPathNavigator,System.String)">
  253.             <summary>
  254.             Return a new XPathNavigator pointing to the first child node
  255.             of the specified name.
  256.             </summary>
  257.             <param name="nodeName">The node name string.</param>
  258.             <param name="startNavigator">Initial node to start search from.</param>
  259.             <returns>An XPathNavigator pointing to the specified child, or null
  260.             for not found.</returns>
  261.         </member>
  262.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.DumpNavTree(System.Xml.XPath.XPathNavigator,System.String)">
  263.             <summary>
  264.             For debugging, display the node local names starting from
  265.             a particular node.
  266.             </summary>
  267.             <param name="nav">The start point.</param>
  268.             <param name="prefix">An indentation prefix for the display.</param>
  269.         </member>
  270.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.GetNamespaceHtmlId(System.String)">
  271.             <summary>
  272.             Turn a namespace name into an html id we can use for links.
  273.             </summary>
  274.             <param name="namespaceName"></param>
  275.             <returns></returns>
  276.         </member>
  277.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.GetTypeHtmlId(System.String)">
  278.             <summary>
  279.             Turn a type name into an html id we can use for links.
  280.             </summary>
  281.             <param name="typeName"></param>
  282.             <returns></returns>
  283.         </member>
  284.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.NamespaceLinkReferenceWrap(System.String)">
  285.             <summary>
  286.             Create a string which wraps the input string to make it a link
  287.             to the specified namespace.
  288.             </summary>
  289.             <param name="namespaceName">The string to wrap.</param>
  290.             <returns>The wrapped string.</returns>
  291.         </member>
  292.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.TypeLinkReferenceWrap(System.String)">
  293.             <summary>
  294.             Create a string which wraps the input string to make it a link
  295.             to the specified type.
  296.             </summary>
  297.             <param name="typeName">The string to wrap.</param>
  298.             <returns>The wrapped string.</returns>
  299.         </member>
  300.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.TypeRefWrap(System.String)">
  301.             <summary>
  302.             Create a string which wraps the input string with a span tag
  303.             with a particular html class attribute.
  304.             </summary>
  305.             <param name="s">The string to wrap.</param>
  306.             <returns>The wrapped string.</returns>
  307.         </member>
  308.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.KeyWrap(System.String)">
  309.             <summary>
  310.             Create a string which wraps the input string with a span tag
  311.             with a particular html class attribute.
  312.             </summary>
  313.             <param name="s">The string to wrap.</param>
  314.             <returns>The wrapped string.</returns>
  315.         </member>
  316.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.StartTable(System.Xml.XmlTextWriter,System.String,System.Int32,System.String[])">
  317.             <summary>
  318.             Write the starting tags for a table to the specified writer.
  319.             </summary>
  320.             <param name="xtw"></param>
  321.             <param name="id">The table id to put in the html.</param>
  322.             <param name="width">The width (pixels) of the table.</param>
  323.             <param name="columnNames">An array of column names to use
  324.             in the header row. This also sets the number of columns.</param>
  325.             <returns>bool - true</returns>
  326.         </member>
  327.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.AddTableEntry(System.Xml.XmlTextWriter,System.Object[])">
  328.             <summary>
  329.             Write a table entry (one row) consisting of one or more columns
  330.             of text.
  331.             </summary>
  332.             <param name="xtw"></param>
  333.             <param name="args">The strings to write.</param>
  334.         </member>
  335.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.AddTableEntryRaw(System.Xml.XmlTextWriter,System.Object[])">
  336.             <summary>
  337.             Write a table entry (one row) consisting of one or more columns
  338.             of text, written Raw.
  339.             </summary>
  340.             <param name="xtw"></param>
  341.             <param name="args">The strings to write.</param>
  342.         </member>
  343.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.EndTable(System.Xml.XmlTextWriter)">
  344.             <summary>
  345.             End a table. This is provided for symmetry, and in case there's
  346.             something else I have to write in tables in the future.
  347.             </summary>
  348.             <param name="xtw"></param>
  349.         </member>
  350.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtml(System.String)">
  351.             <summary>
  352.             Build and emit the html document from the loaded NDoc Xml document.
  353.             </summary>
  354.             <returns></returns>
  355.         </member>
  356.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlForAssembly(System.Xml.XPath.XPathNavigator)">
  357.             <summary>
  358.             Do the build operations given that the specified XPathNavigator is pointing to
  359.             an assembly node.
  360.             </summary>
  361.             <param name="nav">The XPathNavigator pointing to a node of type
  362.             appropriate for this method.</param>
  363.         </member>
  364.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlForModule(System.Xml.XPath.XPathNavigator,System.String,System.String)">
  365.             <summary>
  366.             Do the build operations given that the specified <see cref="T:System.Xml.XPath.XPathNavigator"/> 
  367.             is pointing to a module node.
  368.             </summary>
  369.             <param name="nav">The <see cref="T:System.Xml.XPath.XPathNavigator"/> pointing to a 
  370.             node of a type that's appropriate for this method.</param>
  371.             <param name="assemblyName">The name of the assembly containing the module.</param>
  372.             <param name="assemblyVersion">The version of the assembly containing the module.</param>
  373.         </member>
  374.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlForNamespace(System.Xml.XPath.XPathNavigator,System.String,System.String)">
  375.             <summary>
  376.             Do the build operations given that the specified <see cref="T:System.Xml.XPath.XPathNavigator"/> 
  377.             is pointing to a namespace node.
  378.             </summary>
  379.             <param name="nav">The <see cref="T:System.Xml.XPath.XPathNavigator"/> pointing to a 
  380.             node of a type that's appropriate for this method.</param>
  381.             <param name="assemblyName">The name of the assembly containing this namespace.</param>
  382.             <param name="assemblyVersion">The version of the assembly containing this namespace.</param>
  383.         </member>
  384.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlTypeList(System.Xml.XPath.XPathNavigator,System.String)">
  385.             <summary>
  386.             Write some html containing the list of types in this namespace.
  387.             </summary>
  388.             <param name="nav"></param>
  389.             <param name="namespaceName"></param>
  390.         </member>
  391.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.TypeMatchesIncludeRegexp(System.Xml.XPath.XPathNavigator)">
  392.             <summary>
  393.             This checks whether the Type represented by the specified node
  394.             matches the include type regexp.
  395.             </summary>
  396.             <param name="nav">The XPathNavigator pointing to the type node.</param>
  397.             <returns>bool - true for should be included, false for should be
  398.             excluded.</returns>
  399.         </member>
  400.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlForType(System.Xml.XPath.XPathNavigator,System.String)">
  401.             <summary>
  402.             Builds html for a Type.  An Type here is a class, struct, interface, etc.
  403.             </summary>
  404.             <param name="nav">The XPathNavigator pointing to the type node.</param>
  405.             <param name="namespaceName">The namespace containing this type.</param>
  406.         </member>
  407.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlForTypeUsingXslt(System.Xml.XPath.XPathNavigator,System.Xml.XmlTextWriter,System.String)">
  408.             <summary>
  409.             Use Xslt transform to document this type.
  410.             </summary>
  411.             <param name="nav"></param>
  412.             <param name="xtw"></param>
  413.             <param name="namespaceName"></param>
  414.         </member>
  415.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlForTypeUsingCs(System.Xml.XPath.XPathNavigator,System.Xml.XmlTextWriter,System.String)">
  416.             <summary>
  417.             Document the current node's type using C#.
  418.             </summary>
  419.             <param name="nav"></param>
  420.             <param name="xtw"></param>
  421.             <param name="namespaceName"></param>
  422.         </member>
  423.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlForTypeMember(System.String,System.String,System.Xml.XPath.XPathNavigator,System.Xml.XmlTextWriter)">
  424.             <summary>
  425.             Make (and write) html for a Type (class, interface, ...) member, such
  426.             as a property, field, etc.
  427.             </summary>
  428.             <param name="parentTypeName">The Type's name.</param>
  429.             <param name="memberType">The type of the member (property, field, 
  430.             method, etc)</param>
  431.             <param name="nav">Pointing to the member's node.</param>
  432.             <param name="xtw"></param>
  433.         </member>
  434.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlDetailsForMethod(System.String,System.String,System.Xml.XPath.XPathNavigator,System.Xml.XmlTextWriter)">
  435.             <summary>
  436.             Write html for a single method.
  437.             </summary>
  438.             <param name="parentTypeName"></param>
  439.             <param name="memberType"></param>
  440.             <param name="nav"></param>
  441.             <param name="xtw"></param>
  442.         </member>
  443.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlForMethodParameterDetails(System.Xml.XPath.XPathNavigator,System.Xml.XmlTextWriter)">
  444.             <summary>
  445.             Write a parameter list to the specified writer.
  446.             </summary>
  447.             <param name="nav"><see cref="T:System.Xml.XPath.XPathNavigator"/> to the method's node.</param>
  448.             <param name="xtw">The <see cref="T:System.Xml.XmlTextWriter"/> to write the parameter list to.</param>
  449.         </member>
  450.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeMethodDeclaration(System.Xml.XPath.XPathNavigator,System.String)">
  451.             <summary>
  452.             Make a string for a method (including constructor) declaration, such as 
  453.             "public bool Foo(int x, int y, string s)".
  454.             </summary>
  455.             <param name="nav">Navigator to the Method's node.</param>
  456.             <param name="parentTypeName">The name of the Type which contains this
  457.             method.</param>
  458.             <returns>The declaration string.</returns>
  459.         </member>
  460.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeMethodParametersString(System.Xml.XPath.XPathNavigator)">
  461.             <summary>
  462.             Make a string for a method's parameter list, such as 
  463.             "int x, int y, string s".
  464.             </summary>
  465.             <param name="nav">Navigator to the Method's node.</param>
  466.             <returns>The param list string.</returns>
  467.         </member>
  468.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MakeHtmlTypeDeclaration(System.Xml.XPath.XPathNavigator)">
  469.             <summary>
  470.             Make a string for a Type declaration, such as 
  471.             "public class Foo : IComparable".
  472.             </summary>
  473.             <param name="nav">Navigator to the Type's node.</param>
  474.             <returns>The declaration string.</returns>
  475.         </member>
  476.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.EmitHtml(System.String)">
  477.             <summary>
  478.             This writes the html corresponding to the xml we've already
  479.             internalized.
  480.             </summary>
  481.             <param name="fileName">The name of the file to write to.</param>
  482.             <returns></returns>
  483.         </member>
  484.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.Main(System.String[])">
  485.             <summary>
  486.             The main entry point for the application.
  487.             </summary>
  488.         </member>
  489.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MyConfig">
  490.             <summary>Cast to my type.</summary>
  491.         </member>
  492.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.DevelopmentStatus">
  493.             <summary>
  494.             The development status (alpha, beta, stable) of this documenter.
  495.             Documenters should override this if they aren't stable.
  496.             </summary>
  497.         </member>
  498.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenter.MainOutputFile">
  499.             <summary>See <see cref="T:NDoc.Core.IDocumenter"/>.</summary>
  500.         </member>
  501.         <member name="T:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig">
  502.             <summary>The LinearHtmlDocumenterConfig class.</summary>
  503.         </member>
  504.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.#ctor">
  505.             <summary>Initializes a new instance of the MsdnHelpConfig class.</summary>
  506.             <remarks>
  507.             <para>The LinearHTML Documenter creates a single HTML file that includes
  508.             all of the types and members in your project.</para>
  509.             </remarks>
  510.         </member>
  511.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.IncludeTypeMemberDetails">
  512.             <summary>Gets or sets the IncludeTypeMemberDetails property.</summary>
  513.             <remarks>Whether or not to put type member (methods, fields, properties, ...) details into the 
  514.             document.  For fields and properties this means whether or not to include 
  515.             remarks in the table.  For methods this means whether or not to break out 
  516.             method details (such as parameters) into separate sub-sections.</remarks>
  517.         </member>
  518.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.OutputDirectory">
  519.             <summary>Gets or sets the OutputDirectory property.</summary>
  520.             <remarks>The directory in which the .html file will be generated.</remarks>
  521.         </member>
  522.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.MethodParametersInTable">
  523.             <summary>Gets or sets the MethodParametersInTable property.</summary>
  524.             <remarks>Whether or not to put method parameter lists 
  525.             into the same table with the method name.</remarks>
  526.         </member>
  527.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.TypeIncludeRegexp">
  528.             <summary>Gets or sets the TypeIncludeRegexp property.</summary>
  529.             <remarks>A C# regular expression to include types.  If this is specified,
  530.              only types which match will be included in the output.</remarks>
  531.         </member>
  532.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.NamespaceExcludeRegexp">
  533.             <summary>Gets or sets the NamespaceExcludeRegexp property.</summary>
  534.             <remarks>A C# regular expression to exclude namespaces.</remarks>
  535.         </member>
  536.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.Title">
  537.             <summary>Gets or sets the Title property.</summary>
  538.             <remarks>This is the title displayed at the top of every page.</remarks>
  539.         </member>
  540.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.IncludeHierarchy">
  541.             <summary>Gets or sets the IncludeHierarchy property.</summary>
  542.             <remarks>To include a class hiararchy page for each namespace. 
  543.             Don't turn it on if your project has a namespace with many types, 
  544.             as NDoc will become very slow and might crash.</remarks>
  545.         </member>
  546.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.SortTOCByNamespace">
  547.             <summary>Gets or sets the SortTOCByNamespace property.</summary>
  548.             <remarks>Sorts the TOC by namespace name. SplitTOCs is disabled 
  549.             when this option is selected.</remarks>
  550.         </member>
  551.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.HeaderHtml">
  552.             <summary>Gets or sets the HeaderHtml property.</summary>
  553.             <remarks>Raw HTML that is used as a page header instead of the default blue banner. 
  554.             "%FILE_NAME%" is dynamically replaced by the name of the file for the current html page. 
  555.             "%TOPIC_TITLE%" is dynamically replaced by the title of the current page.</remarks>
  556.         </member>
  557.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.FooterHtml">
  558.             <summary>Gets or sets the FooterHtml property.</summary>
  559.             <remarks>Raw HTML that is used as a page footer instead of the default footer.
  560.             "%FILE_NAME%\" is dynamically replaced by the name of the file for the current html page. 
  561.             "%ASSEMBLY_NAME%\" is dynamically replaced by the name of the assembly for the current page. 
  562.             "%ASSEMBLY_VERSION%\" is dynamically replaced by the version of the assembly for the current page. 
  563.             "%TOPIC_TITLE%\" is dynamically replaced by the title of the current page.</remarks>
  564.         </member>
  565.         <member name="P:NDoc.Documenter.LinearHtml.LinearHtmlDocumenterConfig.FilesToInclude">
  566.             <summary>Gets or sets the FilesToInclude property.</summary>
  567.             <remarks>Specifies external files that must be included 
  568.             in the compiled CHM file. Multiple files must be separated by a pipe ('|').</remarks>
  569.         </member>
  570.         <member name="T:NDoc.Documenter.LinearHtml.LinearHtmlWorkspace">
  571.             <summary>
  572.             Summary description for LatexWorkspace.
  573.             </summary>
  574.         </member>
  575.         <member name="M:NDoc.Documenter.LinearHtml.LinearHtmlWorkspace.#ctor(System.String)">
  576.             <summary>
  577.             Manages the location of the documentation build process
  578.             </summary>
  579.             <param name="rootDir">The location to create the workspace</param>
  580.         </member>
  581.     </members>
  582. </doc>
  583.