<html dir="LTR"> <head> <meta http-equiv="Content-Type" content="text/html; charset=Windows-1252"> </meta> <meta name="generator" content="NDoc 1.3" /> <title>IDocumenter Members</title> <link rel="stylesheet" type="text/css" href="ndoc.css"> </link> <script src="ndoc.js" type="text/javascript"> </script> </head> <body id="bodyID" class="dtBODY"> <div id="nsbanner"> <div id="bannerrow1"> <table class="bannerparthead" cellspacing="0"> <tr id="hdr"> <td class="runninghead" nowrap="true">NDoc 1.3.1 SDK</td> <td class="product" nowrap="true"> </td> </tr> </table> </div> <div id="TitleRow"> <h1 class="dtH1">IDocumenter Members </h1> </div> </div> <div id="nstext"> <p> <a href="NDoc.Core.IDocumenter.html">IDocumenter overview</a> </p> <h4 class="dtH4">Public Instance Properties</h4> <div class="tablediv"> <table class="dtTABLE" cellspacing="0"> <tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.IDocumenter.Config.html">Config</a></td><td width="50%">Gets or sets the documenter's config object.</td></tr> <tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.IDocumenter.DevelopmentStatus.html">DevelopmentStatus</a></td><td width="50%"> The development status (alpha, beta, stable) of this documenter. </td></tr> <tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.IDocumenter.MainOutputFile.html">MainOutputFile</a></td><td width="50%"> Returns the documenter's main output file path. </td></tr> <tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.IDocumenter.Name.html">Name</a></td><td width="50%">Gets the display name for the documenter.</td></tr></table> </div> <h4 class="dtH4">Public Instance Methods</h4> <div class="tablediv"> <table class="dtTABLE" cellspacing="0"> <tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.IDocumenter.Build.html">Build</a></td><td width="50%">Builds the documentation.</td></tr> <tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.IDocumenter.CanBuild_overloads.html">CanBuild</a></td><td width="50%">Overloaded. Checks if the documentation output file(s) exist. </td></tr> <tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.IDocumenter.Clear.html">Clear</a></td><td width="50%">Resets the documenter to a clean state.</td></tr> <tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.IDocumenter.View.html">View</a></td><td width="50%">Spawns a new process to view the generated documentation.</td></tr></table> </div> <h4 class="dtH4">Public Instance Events</h4> <div class="tablediv"> <table class="dtTABLE" cellspacing="0"> <tr VALIGN="top"><td width="50%"><img src="pubevent.gif"></img><a href="NDoc.Core.IDocumenter.DocBuildingProgress.html">DocBuildingProgress</a></td><td width="50%"> Raised to update the current step's percent complete value. </td></tr> <tr VALIGN="top"><td width="50%"><img src="pubevent.gif"></img><a href="NDoc.Core.IDocumenter.DocBuildingStep.html">DocBuildingStep</a></td><td width="50%"> Raised to update the overall percent complete value and the current step name. </td></tr></table> </div> <h4 class="dtH4">See Also</h4> <p> <a href="NDoc.Core.IDocumenter.html">IDocumenter Interface</a> | <a href="NDoc.Core.html">NDoc.Core Namespace</a></p> <object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e" viewastext="true" style="display: none;"> <param name="Keyword" value="IDocumenter interface"> </param> <param name="Keyword" value="NDoc.Core.IDocumenter interface"> </param> <param name="Keyword" value="IDocumenter interface, all members"> </param> </object> <DIV CLASS="footer"> <p> <center> <font color="red"> <i> </i> </font> </center> </p> </DIV> <hr /> <div id="footer"> <p> <a href="mailto:ndoc-helpfeedback@lists.sourceforge.net?subject=NDoc%201.3.1%20SDK%20Documentation%20Feedback:%20IDocumenter%20Members
 ">Send comments on this topic.</a> </p> <p> NDoc development is hosted by <a href="http://sourceforge.net/" target="_parent"><img alt="SourceForge" src="http://sourceforge.net/sflogo.php?group_id=36057&amp;type=5" align="absMiddle" border="0"></a> </p> <p>Generated from assembly NDoc.Core [1.3.1851.0]</p> </div> </div> </body> </html>