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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
<?xml version="1.0"?>
<doc>
<assembly>
<name>NDoc.Documenter.NAnt</name>
</assembly>
<members>
<member name="T:NDoc.Documenter.NAnt.NAntDocumenter">
<summary>
NDoc Documenter for building custom NAnt User documentation.
</summary>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntDocumenter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:NDoc.Documenter.NAnt.NAntDocumenter"/> class.
</summary>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntDocumenter.Clear">
<summary>
Resets the documenter to a clean state.
</summary>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntDocumenter.Build(NDoc.Core.Project)">
<summary>
Builds the documentation.
</summary>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenter.OutputDirectory">
<summary>
Gets the documenter's output directory.
</summary>
<value>
The documenter's output directory.
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenter.NamespaceFilter">
<summary>
Gets or sets the root namespace to document.
</summary>
<value>
The root namespace to document, or a empty <see cref="T:System.String"/>
if no restriction should be set on the namespace to document.
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenter.ProductName">
<summary>
Gets the name of the product for which documentation should be
generated.
</summary>
<value>
The name of the product for which documentation should be
generated.
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenter.ProductVersion">
<summary>
Gets the version of the product for which documentation should be
generated.
</summary>
<value>
The version of the product for which documentation should be
generated.
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenter.ProductUrl">
<summary>
Gets the URL of the website of the product for which documentation
should be generated.
</summary>
<value>
The URL of the website of the product for which documentation should
be generated.
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenter.MainOutputFile">
<summary>
Gets the documenter's main output file.
</summary>
<value>
The documenter's main output file.
</value>
</member>
<member name="T:NDoc.Documenter.NAnt.NAntDocumenterConfig">
<summary>
NDoc configuration class for <see cref="T:NDoc.Documenter.NAnt.NAntDocumenter"/>.
</summary>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntDocumenterConfig.#ctor">
<summary>
Initializes a new instance of the <see cref="T:NDoc.Documenter.NAnt.NAntDocumenterConfig"/>
class.
</summary>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenterConfig.OutputDirectory">
<summary>
Gets or sets the output directory.
</summary>
<value>
The output directory.
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenterConfig.SdkLinksOnWeb">
<summary>
Gets or sets a value indicating whether .NET Framework SDK links
should point to the online MSDN library.
</summary>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenterConfig.ProductName">
<summary>
Gets or sets the name of the product for which documentation
should be generated.
</summary>
<value>
The name of the product for which documentation should be
generated. The default is "NAnt".
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenterConfig.ProductVersion">
<summary>
Gets or sets the version of the product for which documentation
should be generated.
</summary>
<value>
The version of the product for which documentation should be
generated.
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenterConfig.ProductUrl">
<summary>
Gets or sets the URL of product website.
</summary>
<value>
The URL of the website of the product for which documentation should
be generated.
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenterConfig.NAntBaseUri">
<summary>
Gets or sets the base URI for linking to NAnt docs.
</summary>
<value>
The base URI for linking to NAnt docs.
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntDocumenterConfig.NamespaceFilter">
<summary>
Gets or sets the root namespace to document.
</summary>
<value>
The root namespace to document, or a empty <see cref="T:System.String"/>
if no restriction should be set on the namespace to document.
</value>
</member>
<member name="T:NDoc.Documenter.NAnt.NAntXsltUtilities">
<summary>
Provides an extension object for the XSLT transformations.
</summary>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.#ctor(System.Xml.XmlDocument,NDoc.Documenter.NAnt.NAntDocumenterConfig)">
<summary>
Initializes a new instance of the <see cref="T:NDoc.Documenter.NAnt.NAntXsltUtilities"/>
class.
</summary>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetNamespaceFilter">
<summary>
Gets the root namespace to document.
</summary>
<returns>
The root namespace to document, or a empty <see cref="T:System.String"/>
if no restriction should be set on the namespace to document.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetClassNode(System.String)">
<summary>
Searches the document for the <c><class></c> node with the
given id.
</summary>
<param name="type">Type.FullName of class to return</param>
<returns>
The <c><class></c> node with the given id, or <see langword="null" />
if the node does not exist.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetHRef(System.String)">
<summary>
Returns an href for a cref.
</summary>
<param name="cref">The cref for which the href will be looked up.</param>
<returns>
The href for the specified cref.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetName(System.String)">
<summary>
Returns the name for a given cref.
</summary>
<param name="cref">The cref for which the name will be looked up.</param>
<returns>
The name for the specified cref.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetTaskName(System.String)">
<summary>
Returns the NAnt task name for a given cref.
</summary>
<param name="cref">The cref for the task name will be looked up.</param>
<returns>
The NAnt task name for the specified cref.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetElementName(System.String)">
<summary>
Returns the NAnt element name for a given cref.
</summary>
<param name="cref">The cref for the element name will be looked up.</param>
<returns>
The NAnt element name for the specified cref.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetElementDocType(System.Xml.XmlNode)">
<summary>
Determines the <see cref="T:NDoc.Documenter.NAnt.ElementDocType"/> of the given type node.
</summary>
<param name="typeNode">The type node for which to determine the <see cref="T:NDoc.Documenter.NAnt.ElementDocType"/>.</param>
<returns>
The <see cref="T:NDoc.Documenter.NAnt.ElementDocType"/> of the given type node.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetElementDocTypeByID(System.String)">
<summary>
Determines the <see cref="T:NDoc.Documenter.NAnt.ElementDocType"/> of the type to which
the given cref points.
</summary>
<param name="cref">The cref for which to determine the <see cref="T:NDoc.Documenter.NAnt.ElementDocType"/>.</param>
<returns>
The <see cref="T:NDoc.Documenter.NAnt.ElementDocType"/> of the type to which the given
cref points.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.IsDataType(System.String)">
<summary>
Determines whether the given cref points to a <c>datatype</c>.
</summary>
<param name="cref">The cref to check.</param>
<returns>
<see langword="true" /> if the given cref points to a <c>datatype</c>;
otherwise, <see langword="false" />.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.IsElement(System.String)">
<summary>
Determines whether the given cref points to an <c>element</c>.
</summary>
<param name="cref">The cref to check.</param>
<returns>
<see langword="true"/> if the given cref points to an <c>element</c>;
otherwise, <see langword="false"/>.
</returns>
<remarks>
When the cref points to a <see cref="T:NAnt.Core.Task"/> or <see cref="T:NAnt.Core.DataTypeBase"/>
this method returns <see langword="false"/>.
</remarks>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.IsFilter(System.String)">
<summary>
Determines whether the given cref points to a <c>datatype</c>.
</summary>
<param name="cref">The cref to check.</param>
<returns>
<see langword="true" /> if the given cref points to a <c>datatype</c>;
otherwise, <see langword="false" />.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.IsTask(System.String)">
<summary>
Determines whether the given cref points to a <c>task</c>.
</summary>
<param name="cref">The cref to check.</param>
<returns>
<see langword="true" /> if the given cref points to a <c>task</c>;
otherwise, <see langword="false" />.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.IsFunctionSet(System.String)">
<summary>
Determines whether the given cref points to a <c>functionset</c>.
</summary>
<param name="cref">The cref to check.</param>
<returns>
<see langword="true" /> if the given cref points to a <c>functionset</c>;
otherwise, <see langword="false" />.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.UrlEncode(System.String)">
<summary>
Encodes a URL string using <see cref="P:System.Text.Encoding.UTF8"/> for reliable
HTTP transmission from the Web server to a client.
</summary>
<param name="value">The text to encode.</param>
<returns>
The encoded string.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetElementNameForProperty(System.Xml.XmlNode)">
<summary>
Gets the BuildElementAttribute name for the "class/property" XmlNode
</summary>
<param name="propertyNode">The XmlNode to look for a name.</param>
<returns>The BuildElementAttrbute.Name if the attribute exists for the node.</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetFileNameForFunction(System.Xml.XmlNode,System.Boolean)">
<summary>
Returns the filename to use for the given function XmlElement
</summary>
<param name="typeNode">The "method" element to find the filename for.</param>
<param name="urlEncode">Specified whether to URLencode the filename.</param>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetFileNameForType(System.Xml.XmlNode,System.Boolean)">
<summary>
Returns the filename to use for the given class XmlNode
</summary>
<param name="typeNode">The "Class" element to find the filename for.</param>
<returns>
The relative path and filename where this type is stored in the
documentation.
</returns>
<remarks>
For a type that is neither a task, enum, global type, filter or
functionset, the returned filename will point to the SDK docs for
that type.
</remarks>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetTaskNameForType(System.Xml.XmlNode)">
<summary>
Gets the TaskNameAttrbute name for the "class" XmlNode
</summary>
<param name="propertyNode">The XmlNode to look for a name.</param>
<returns>The <see cref="!:TaskNameAttribute.Name"/> if the attribute exists for the node.</returns>
<remarks>
The class is also checked to make sure it is derived from <see cref="T:NAnt.Core.Task"/>
</remarks>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetElementNameForMethod(System.Xml.XmlNode)">
<summary>
Gets the function name for methods that represent a NAtn function.
</summary>
<param name="methodNode">The XmlNode to look for a name.</param>
<returns>
The function name if <paramref name="methodNode" /> represent a
NAnt function.
</returns>
</member>
<member name="M:NDoc.Documenter.NAnt.NAntXsltUtilities.GetHRefForFunctionSet(System.Xml.XmlNode)">
<summary>
Returns a partial URL to link to the functionset in the function index.
</summary>
<param name="typeNode">The "Class" element to find the filename for.</param>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntXsltUtilities.SdkDocBaseUrl">
<summary>
Gets the base url for links to system types.
</summary>
<value>
The base url for links to system types.
</value>
</member>
<member name="P:NDoc.Documenter.NAnt.NAntXsltUtilities.SdkDocExt">
<summary>
Gets the page file extension for links to system types.
</summary>
</member>
</members>
</doc>
|
