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
|
<html dir="LTR">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
</meta>
<meta name="generator" content="NDoc 1.3" />
<title>UseNamespaceDocSummaries Property</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">
<INPUT class="userDataStyle" id="userDataCache" type="hidden" />
<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.UseNamespaceDocSummaries Property</h1>
</div>
</div>
<div id="nstext">
<p>Gets or sets the UseNamespaceDocSummaries property.</p>
<PRE class="syntax"><SPAN class="lang">[Visual Basic]
</SPAN><div class="attribute"><Category(Category:="Documentation Main Settings"), _
Description(Description:="If true, the documenter will look for a class with the name "NamespaceDoc" in each namespace. The summary from that class will then be used as the namespace summary. The class itself will not show up in the resulting documentation output. You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies."), _
DefaultValue(Value:=False)></div><b>PublicPropertyUseNamespaceDocSummariesAs<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemBooleanClassTopic.asp">Boolean</a>
</b><SPAN class="lang">[C#]
</SPAN><div class="attribute">[Category(Category="Documentation Main Settings")]</div><div class="attribute">[Description(Description="If true, the documenter will look for a class with the name "NamespaceDoc" in each namespace. The summary from that class will then be used as the namespace summary. The class itself will not show up in the resulting documentation output. You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.")]</div><div class="attribute">[DefaultValue(Value=False)]</div><b>public<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemBooleanClassTopic.asp">bool</a>UseNamespaceDocSummaries{get;set;}
</b><SPAN class="lang">[C++]
</SPAN><div class="attribute">[Category(Category="Documentation Main Settings")]</div><div class="attribute">[Description(Description="If true, the documenter will look for a class with the name "NamespaceDoc" in each namespace. The summary from that class will then be used as the namespace summary. The class itself will not show up in the resulting documentation output. You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.")]</div><div class="attribute">[DefaultValue(Value=False)]</div><b>public:__property<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemBooleanClassTopic.asp">bool</a>get_UseNamespaceDocSummaries();
public:__property<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemVoidClassTopic.asp">void</a>set_UseNamespaceDocSummaries(<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemBooleanClassTopic.asp">bool</a>);
</b><SPAN class="lang">[JScript]
</SPAN><b>public<div class="attribute">Category(Category="Documentation Main Settings")</div><div class="attribute">Description(Description="If true, the documenter will look for a class with the name "NamespaceDoc" in each namespace. The summary from that class will then be used as the namespace summary. The class itself will not show up in the resulting documentation output. You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.")</div><div class="attribute">DefaultValue(Value=False)</div>functiongetUseNamespaceDocSummaries():<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemBooleanClassTopic.asp">bool</a>
public<div class="attribute">Category(Category="Documentation Main Settings")</div><div class="attribute">Description(Description="If true, the documenter will look for a class with the name "NamespaceDoc" in each namespace. The summary from that class will then be used as the namespace summary. The class itself will not show up in the resulting documentation output. You may want to use #if ... #endif together with conditional compilation constants to exclude the NamespaceDoc classes from release build assemblies.")</div><div class="attribute">DefaultValue(Value=False)</div>functionsetUseNamespaceDocSummaries(<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemBooleanClassTopic.asp">bool</a>);
</b></PRE><h4 class="dtH4">Remarks</h4><p>If true, the documenter will look for a class with the name <b>NamespaceDoc</b> in each namespace. The summary from that class will then be used as the namespace summary. The class itself will not show up in the resulting documentation output. <p>You may want to use <b>#if</b> ... <b>#endif</b> together with conditional compilation constants to exclude the <b>NamespaceDoc</b> classes from release build assemblies.</p></p><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="UseNamespaceDocSummaries property"></param><param name="Keyword" value="UseNamespaceDocSummaries property, BaseReflectionDocumenterConfig class"></param><param name="Keyword" value="BaseReflectionDocumenterConfig.UseNamespaceDocSummaries property"></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.UseNamespaceDocSummaries%20Property
 ">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>
|
