1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
|
<html dir="LTR">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
</meta>
<meta name="generator" content="NDoc 1.3" />
<title>BaseReflectionDocumenterConfig 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">BaseReflectionDocumenterConfig Members
</h1>
</div>
</div>
<div id="nstext">
<p>
<a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.html">BaseReflectionDocumenterConfig 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.Reflection.BaseReflectionDocumenterConfig.AssemblyVersionInfo.html">AssemblyVersionInfo</a></td><td width="50%">Gets or sets the AssemblyVersion property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.AutoDocumentConstructors.html">AutoDocumentConstructors</a></td><td width="50%">Gets or sets the AutoDocumentConstructors property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.AutoPropertyBackerSummaries.html">AutoPropertyBackerSummaries</a></td><td width="50%">Gets or sets the AutoPropertyBackerSummaries property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.CleanIntermediates.html">CleanIntermediates</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%">Gets or sets a value indicating whether to delete intermediate files after a successful build.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.CopyrightHref.html">CopyrightHref</a></td><td width="50%">Gets or sets the CopyrightHref property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.CopyrightText.html">CopyrightText</a></td><td width="50%">Gets or sets the CopyrightText property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentAttributes.html">DocumentAttributes</a></td><td width="50%">Gets or sets whether or not to document the attributes.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentedAttributes.html">DocumentedAttributes</a></td><td width="50%">Gets or sets which attributes should be documented.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentEmptyNamespaces.html">DocumentEmptyNamespaces</a></td><td width="50%">Gets or sets the DocumentPrivates property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentExplicitInterfaceImplementations.html">DocumentExplicitInterfaceImplementations</a></td><td width="50%">Gets or sets the DocumentInternals property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentInheritedAttributes.html">DocumentInheritedAttributes</a></td><td width="50%">Gets or sets whether or not to document the attributes inherited from base types.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentInheritedFrameworkMembers.html">DocumentInheritedFrameworkMembers</a></td><td width="50%">Gets or sets the DocumentInheritedFrameworkMembers property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentInheritedMembers.html">DocumentInheritedMembers</a></td><td width="50%">Gets or sets the DocumentInheritedMembers property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentInternals.html">DocumentInternals</a></td><td width="50%">Gets or sets the DocumentInternals property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentPrivates.html">DocumentPrivates</a></td><td width="50%">Gets or sets the DocumentPrivates property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentProtected.html">DocumentProtected</a></td><td width="50%">Gets or sets the DocumentProtected property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentProtectedInternalAsProtected.html">DocumentProtectedInternalAsProtected</a></td><td width="50%">Gets or sets the DocumentProtectedInternalAsProtected property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentSealedProtected.html">DocumentSealedProtected</a></td><td width="50%">Gets or sets the DocumentSealedProtected property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.EditorBrowsableFilter.html">EditorBrowsableFilter</a></td><td width="50%">Specifies the level of filtering on the EditorBrowsable attribute.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.FeedbackEmailAddress.html">FeedbackEmailAddress</a></td><td width="50%">Gets or sets the FeedbackEmailAddress property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.IncludeDefaultThreadSafety.html">IncludeDefaultThreadSafety</a></td><td width="50%">Gets or sets the IncludeDefaultThreadSafety property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.InstanceMembersDefaultToSafe.html">InstanceMembersDefaultToSafe</a></td><td width="50%">Gets or sets the InstanceMembersDefaultToSafe property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.Name.html">Name</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%"> Gets the display name of the documenter. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.Preliminary.html">Preliminary</a></td><td width="50%">Get/set the Preliminary preoperty</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ReferencePaths.html">ReferencePaths</a></td><td width="50%"> Gets or sets a collection of additional paths to search for reference assemblies. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.SdkDocLanguage.html">SdkDocLanguage</a></td><td width="50%">Gets or sets the SdkDocLanguage property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.SdkDocVersion.html">SdkDocVersion</a></td><td width="50%">Gets or sets the LinkToSdkDocVersion property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowMissingParams.html">ShowMissingParams</a></td><td width="50%">Gets or sets the ShowMissingParams property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowMissingRemarks.html">ShowMissingRemarks</a></td><td width="50%">Gets or sets the ShowMissingRemarks property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowMissingReturns.html">ShowMissingReturns</a></td><td width="50%">Gets or sets the ShowMissingReturns property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowMissingSummaries.html">ShowMissingSummaries</a></td><td width="50%">Gets or sets the ShowMissingSummaries property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowMissingValues.html">ShowMissingValues</a></td><td width="50%">Gets or sets the ShowMissingValues property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowTypeIdInAttributes.html">ShowTypeIdInAttributes</a></td><td width="50%">Gets or sets whether or not to show the TypeId property in attributes.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.SkipNamespacesWithoutSummaries.html">SkipNamespacesWithoutSummaries</a></td><td width="50%">Gets or sets the SkipNamespacesWithoutSummaries property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.StaticMembersDefaultToSafe.html">StaticMembersDefaultToSafe</a></td><td width="50%">Gets or sets the StaticMembersDefaultToSafe property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.UseNamespaceDocSummaries.html">UseNamespaceDocSummaries</a></td><td width="50%">Gets or sets the UseNamespaceDocSummaries property.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.UseNDocXmlFile.html">UseNDocXmlFile</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%">Gets or sets a value indicating whether to use the specified XML file as input instead of reflecting the list of assemblies specified on the project.</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="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassEqualsTopic.asp">Equals</a> (inherited from <b>Object</b>)</td><td width="50%">
Determines whether the specified <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassTopic.asp">Object</a> is equal to the current <b>Object</b>.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassGetHashCodeTopic.asp">GetHashCode</a> (inherited from <b>Object</b>)</td><td width="50%">
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.GetProperties.html">GetProperties</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%">Gets an enumerable list of <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemReflectionPropertyInfoClassTopic.asp">PropertyInfo</a> objects representing the properties of this config.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassGetTypeTopic.asp">GetType</a> (inherited from <b>Object</b>)</td><td width="50%">
Gets the <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemTypeClassTopic.asp">Type</a> of the current instance.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.Read.html">Read</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%">Loads config details from the specified <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemXmlXmlReaderClassTopic.asp">XmlReader</a>.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.SetProject.html">SetProject</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%">Associates this config with a <a href="NDoc.Core.BaseDocumenterConfig.Project.html">Project</a>.</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.SetValue.html">SetValue</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%"> Sets the value of a named config property. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassToStringTopic.asp">ToString</a> (inherited from <b>Object</b>)</td><td width="50%">
Returns a <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemStringClassTopic.asp">String</a> that represents the current <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassTopic.asp">Object</a>.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.Write.html">Write</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%">Writes the current state of the config to the specified <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemXmlXmlWriterClassTopic.asp">XmlWriter</a>.</td></tr></table>
</div>
<h4 class="dtH4">Protected Instance Constructors</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif" /><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfigConstructor.html">BaseReflectionDocumenterConfig Constructor</a></td><td width="50%"> Initializes a new instance of the <a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.html">BaseReflectionDocumenterConfig</a> class. </td></tr></table>
</div>
<h4 class="dtH4">Protected Instance Properties</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="protproperty.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.Project.html">Project</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%"> Gets the <b>Project</b> that this config is associated with, if any </td></tr></table>
</div>
<h4 class="dtH4">Protected Instance Methods</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassFinalizeTopic.asp">Finalize</a> (inherited from <b>Object</b>)</td><td width="50%">
Allows an <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassTopic.asp">Object</a> to attempt to free resources and perform other cleanup operations before the <b>Object</b> is reclaimed by garbage collection.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.HandleUnknownPropertyType.html">HandleUnknownPropertyType</a></td><td width="50%">
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.HandleUnknownPropertyValue.html">HandleUnknownPropertyValue</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%"> When overridden in a derived class, handles a unknown or invalid property value read by <a href="NDoc.Core.BaseDocumenterConfig.Read.html">Read</a>. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassMemberwiseCloneTopic.asp">MemberwiseClone</a> (inherited from <b>Object</b>)</td><td width="50%">
Creates a shallow copy of the current <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassTopic.asp">Object</a>.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.ReadProperty.html">ReadProperty</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%"> Sets the value of a named property. </td></tr>
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="NDoc.Core.BaseDocumenterConfig.SetDirty.html">SetDirty</a> (inherited from <b>BaseDocumenterConfig</b>)</td><td width="50%">Sets the <a href="NDoc.Core.Project.IsDirty.html">IsDirty</a> property on the <a href="NDoc.Core.BaseDocumenterConfig.Project.html">Project</a>.</td></tr></table>
</div>
<h4 class="dtH4">See Also</h4>
<p>
<a href="NDoc.Core.Reflection.BaseReflectionDocumenterConfig.html">BaseReflectionDocumenterConfig Class</a> | <a href="NDoc.Core.Reflection.html">NDoc.Core.Reflection Namespace</a></p>
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e" viewastext="true" style="display: none;">
<param name="Keyword" value="BaseReflectionDocumenterConfig class">
</param>
<param name="Keyword" value="NDoc.Core.Reflection.BaseReflectionDocumenterConfig class">
</param>
<param name="Keyword" value="BaseReflectionDocumenterConfig class, 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:%20BaseReflectionDocumenterConfig%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>
|