7
<member name="T:NDoc.Core.Reflection.ReflectionEngine">
9
Summary description for ReflectionEngine.
12
<member name="M:NDoc.Core.Reflection.ReflectionEngine.#ctor">
14
constructor for ReflectionEngine.
17
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetNamespacesFromAssembly(NDoc.Core.Reflection.ReflectionEngineParameters,System.String)">
19
Gets the namespaces from assembly.
21
<param name="rep">ReflectionEngine Parameters.</param>
22
<param name="assemblyFile">Assembly file name.</param>
25
<member name="M:NDoc.Core.Reflection.ReflectionEngine.MakeXmlFile(NDoc.Core.Reflection.ReflectionEngineParameters,System.String)">
26
<summary>Builds an Xml file combining the reflected metadata with the /doc comments.</summary>
27
<returns>full pathname of XML file</returns>
28
<remarks>The caller is responsible for deleting the xml file after use...</remarks>
30
<member name="M:NDoc.Core.Reflection.ReflectionEngine.MakeXml(NDoc.Core.Reflection.ReflectionEngineParameters)">
31
<summary>Builds an Xml string combining the reflected metadata with the /doc comments.</summary>
32
<remarks>This now evidently writes the string in utf-16 format (and
33
says so, correctly I suppose, in the xml text) so if you write this string to a file with
34
utf-8 encoding it will be unparseable because the file will claim to be utf-16
35
but will actually be utf-8.</remarks>
36
<returns>XML string</returns>
38
<member name="M:NDoc.Core.Reflection.ReflectionEngine.BuildXml(System.Xml.XmlWriter)">
39
<summary>Builds an Xml file combining the reflected metadata with the /doc comments.</summary>
41
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WriteModule(System.Xml.XmlWriter,System.Reflection.Module)">
42
<summary>Writes documentation about a module out as XML.</summary>
43
<param name="writer">XmlWriter to write on.</param>
44
<param name="module">Module to document.</param>
46
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WriteClass(System.Xml.XmlWriter,System.Type,System.Boolean)">
47
<summary>Writes XML documenting a class.</summary>
48
<param name="writer">XmlWriter to write on.</param>
49
<param name="type">Class to document.</param>
50
<param name="hiding">true if hiding base members</param>
52
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WriteInterface(System.Xml.XmlWriter,System.Type)">
53
<summary>Writes XML documenting an interface.</summary>
54
<param name="writer">XmlWriter to write on.</param>
55
<param name="type">Interface to document.</param>
57
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WriteDelegate(System.Xml.XmlWriter,System.Type)">
58
<summary>Writes XML documenting a delegate.</summary>
59
<param name="writer">XmlWriter to write on.</param>
60
<param name="type">Delegate to document.</param>
62
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WriteEnumeration(System.Xml.XmlWriter,System.Type)">
63
<summary>Writes XML documenting an enumeration.</summary>
64
<param name="writer">XmlWriter to write on.</param>
65
<param name="type">Enumeration to document.</param>
67
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WriteField(System.Xml.XmlWriter,System.Reflection.FieldInfo,System.Type,System.Boolean)">
68
<summary>Writes XML documenting a field.</summary>
69
<param name="writer">XmlWriter to write on.</param>
70
<param name="field">Field to document.</param>
71
<param name="type">Type containing the field.</param>
72
<param name="hiding">true if hiding base members</param>
74
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetDisplayValue(System.Type,System.Object)">
78
<param name="parent"></param>
79
<param name="value"></param>
82
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WriteEvent(System.Xml.XmlWriter,System.Reflection.EventInfo)">
83
<summary>Writes XML documenting an event.</summary>
84
<param name="writer">XmlWriter to write on.</param>
85
<param name="eventInfo">Event to document.</param>
87
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WriteConstructor(System.Xml.XmlWriter,System.Reflection.ConstructorInfo,System.Int32)">
88
<summary>Writes XML documenting a constructor.</summary>
89
<param name="writer">XmlWriter to write on.</param>
90
<param name="constructor">Constructor to document.</param>
91
<param name="overload">If > 0, indicates this is the nth overloaded constructor.</param>
93
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WriteProperty(System.Xml.XmlWriter,System.Reflection.PropertyInfo,System.Boolean,System.Int32,System.Boolean)">
94
<summary>Writes XML documenting a property.</summary>
95
<param name="writer">XmlWriter to write on.</param>
96
<param name="property">Property to document.</param>
97
<param name="inherited">true if a declaringType attribute should be included.</param>
98
<param name="overload">If > 0, indicates this it the nth overloaded method with the same name.</param>
99
<param name="hiding">true if this property is hiding base class members with the same name.</param>
101
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WriteMethod(System.Xml.XmlWriter,System.Reflection.MethodInfo,System.Boolean,System.Int32,System.Boolean)">
102
<summary>Writes XML documenting a method.</summary>
103
<param name="writer">XmlWriter to write on.</param>
104
<param name="method">Method to document.</param>
105
<param name="inherited">true if a declaringType attribute should be included.</param>
106
<param name="overload">If > 0, indicates this it the nth overloaded method with the same name.</param>
107
<param name="hiding">true if this method hides methods of the base class with the same signature.</param>
109
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetTypeNamespaceName(System.Type)">
110
<summary>Used by GetMemberName(Type type) and by
111
GetFullNamespaceName(MemberInfo member) functions to build
112
up most of the /doc member name.</summary>
113
<param name="type"></param>
115
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetFullNamespaceName(System.Reflection.MemberInfo)">
116
<summary>Used by all the GetMemberName() functions except the
117
Type one. It returns most of the /doc member name.</summary>
118
<param name="member"></param>
120
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetTypeName(System.Type)">
121
<summary>Derives the ID for a type. Used to match nodes in the /doc XML.</summary>
122
<param name="type">The type to derive the member name ID from.</param>
124
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetMemberName(System.Type)">
125
<summary>Derives the member name ID for a type. Used to match nodes in the /doc XML.</summary>
126
<param name="type">The type to derive the member name ID from.</param>
128
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetMemberName(System.Reflection.FieldInfo)">
129
<summary>Derives the member name ID for a field. Used to match nodes in the /doc XML.</summary>
130
<param name="field">The field to derive the member name ID from.</param>
132
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetMemberName(System.Reflection.FieldInfo,System.Type)">
133
<summary>Derives the member name ID for the base of an inherited field.</summary>
134
<param name="field">The field to derive the member name ID from.</param>
135
<param name="declaringType">The declaring type.</param>
137
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetMemberName(System.Reflection.EventInfo)">
138
<summary>Derives the member name ID for an event. Used to match nodes in the /doc XML.</summary>
139
<param name="eventInfo">The event to derive the member name ID from.</param>
141
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetMemberName(System.Reflection.EventInfo,System.Type)">
142
<summary>Derives the member name ID for an event. Used to match nodes in the /doc XML.</summary>
143
<param name="eventInfo">The event to derive the member name ID from.</param>
144
<param name="declaringType">The declaring type.</param>
146
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetMemberName(System.Reflection.PropertyInfo)">
147
<summary>Derives the member name ID for a property. Used to match nodes in the /doc XML.</summary>
148
<param name="property">The property to derive the member name ID from.</param>
150
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetMemberName(System.Reflection.PropertyInfo,System.Type)">
151
<summary>Derives the member name ID for the base of an inherited property.</summary>
152
<param name="property">The property to derive the member name ID from.</param>
153
<param name="declaringType">The declaring type.</param>
155
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetMemberName(System.Reflection.MethodBase)">
156
<summary>Derives the member name ID for a member function. Used to match nodes in the /doc XML.</summary>
157
<param name="method">The method to derive the member name ID from.</param>
159
<member name="M:NDoc.Core.Reflection.ReflectionEngine.GetMemberName(System.Reflection.MethodBase,System.Type)">
160
<summary>Derives the member name ID for the basse of an inherited member function.</summary>
161
<param name="method">The method to derive the member name ID from.</param>
162
<param name="declaringType">The declaring type.</param>
164
<member name="M:NDoc.Core.Reflection.ReflectionEngine.CheckForPropertyBacker(System.Xml.XmlWriter,System.String,System.Type)">
166
This checks whether a field is a property backer, meaning
167
it stores the information for the property.
170
<para>This takes advantage of the fact that most people
171
have a simple convention for the names of the fields
172
and the properties that they back.
173
If the field doesn't have a summary already, and it
174
looks like it backs a property, and the BaseDocumenterConfig
175
property is set appropriately, then this adds a
176
summary indicating that.</para>
177
<para>Note that this design will call multiple fields the
178
backer for a single property.</para>
179
<para/>This also will call a public field a backer for a
180
property, when typically that wouldn't be the case.
182
<param name="writer">The XmlWriter to write to.</param>
183
<param name="memberName">The full name of the field.</param>
184
<param name="type">The Type which contains the field
185
and potentially the property.</param>
186
<returns>True only if a property backer is auto-documented.</returns>
188
<member name="M:NDoc.Core.Reflection.ReflectionEngine.FindProperty(System.String,System.Type)">
190
Find a particular property of the specified type, by name.
191
Return the PropertyInfo for it.
193
<param name="expectedPropertyName">The name of the property to
195
<param name="type">The type in which to search for
196
the property.</param>
197
<returns>PropertyInfo - The property info, or null for
200
<member name="M:NDoc.Core.Reflection.ReflectionEngine.WritePropertyBackerDocumentation(System.Xml.XmlWriter,System.String,System.Reflection.PropertyInfo)">
202
Write xml info for a property's backer field to the specified writer.
203
This writes a string with a link to the property.
205
<param name="writer">The XmlWriter to write to.</param>
206
<param name="element">The field which backs the property.</param>
207
<param name="property">The property backed by the field.</param>
209
<member name="T:NDoc.Core.Reflection.ReflectionEngine.DerivedTypesCollection">
211
Maintains a cache of all base classes and their directly derived children
214
<member name="T:NDoc.Core.Reflection.ReflectionEngine.InterfaceImplementingTypesCollection">
216
Maintains a cache of all base interfaces and the Types that implement them.
219
<member name="T:NDoc.Core.Reflection.ReflectionEngine.BaseInterfacesCollection">
221
Maintains a cache of all interfaces directly declared on class declaration
224
<member name="T:NDoc.Core.Reflection.ReflectionEngineParameters">
226
Summary description for ReflectionEngineParameters.
229
<member name="M:NDoc.Core.Reflection.ReflectionEngineParameters.#ctor(NDoc.Core.Project)">
231
constructor for ReflectionEngineParameters.
234
<member name="M:NDoc.Core.Reflection.ReflectionEngineParameters.#ctor(NDoc.Core.Project,NDoc.Core.Reflection.BaseReflectionDocumenterConfig)">
236
constructor for ReflectionEngineParameters.
239
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.AssemblyFileNames">
244
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.XmlDocFileNames">
249
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.ReferencePaths">
254
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.NamespaceSummaries">
259
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.AssemblyVersionInfo">
264
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.UseNamespaceDocSummaries">
269
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.AutoPropertyBackerSummaries">
274
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.AutoDocumentConstructors">
279
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.SdkDocLanguage">
284
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.ShowMissingSummaries">
289
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.ShowMissingRemarks">
294
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.ShowMissingParams">
299
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.ShowMissingReturns">
304
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.ShowMissingValues">
309
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentInheritedMembers">
314
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentInheritedFrameworkMembers">
319
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentExplicitInterfaceImplementations">
324
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentInternals">
329
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentProtected">
334
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentSealedProtected">
339
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentPrivates">
344
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentProtectedInternalAsProtected">
349
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentEmptyNamespaces">
354
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.SkipNamespacesWithoutSummaries">
359
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.EditorBrowsableFilter">
364
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentAttributes">
369
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentInheritedAttributes">
374
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.ShowTypeIdInAttributes">
379
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.DocumentedAttributes">
384
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.CopyrightText">
389
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.CopyrightHref">
394
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.FeedbackEmailAddress">
399
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.Preliminary">
404
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.IncludeDefaultThreadSafety">
409
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.StaticMembersDefaultToSafe">
414
<member name="F:NDoc.Core.Reflection.ReflectionEngineParameters.InstanceMembersDefaultToSafe">
419
<member name="T:NDoc.Core.Reflection.AssemblyLoader">
421
Handles the resolution and loading of assemblies.
424
<member name="F:NDoc.Core.Reflection.AssemblyLoader.SearchDirectories">
425
<summary>primary search directories.</summary>
427
<member name="F:NDoc.Core.Reflection.AssemblyLoader.directoryLists">
428
<summary>List of subdirectory lists already scanned.</summary>
430
<member name="F:NDoc.Core.Reflection.AssemblyLoader.searchedDirectories">
431
<summary>List of directories already scanned.</summary>
433
<member name="F:NDoc.Core.Reflection.AssemblyLoader.unresolvedAssemblies">
434
<summary>List of Assemblies that could not be resolved.</summary>
436
<member name="F:NDoc.Core.Reflection.AssemblyLoader.AssemblyNameFileNameMap">
437
<summary>assemblies already scanned, but not loaded.</summary>
438
<remarks>Maps Assembly FullName to Filename for assemblies scanned,
439
but not loaded because they were not a match to the required FullName.
440
<p>This list is scanned twice,</p>
441
<list type="unordered">
442
<term>If the requested assembly has not been loaded, but is in this list, then the file is loaded.</term>
443
<term>Once all search paths have been exhausted in an exact name match, this list is checked for a 'partial' match.</term>
446
<member name="M:NDoc.Core.Reflection.AssemblyLoader.#ctor(NDoc.Core.ReferencePathCollection)">
448
Initializes a new instance of the <see cref="T:NDoc.Core.Reflection.AssemblyLoader"/> class.
450
<param name="referenceDirectories">Reference directories.</param>
452
<member name="M:NDoc.Core.Reflection.AssemblyLoader.Install">
454
Installs the assembly resolver by hooking up to the AppDomain's AssemblyResolve event.
457
<member name="M:NDoc.Core.Reflection.AssemblyLoader.Deinstall">
459
Deinstalls the assembly resolver.
462
<member name="M:NDoc.Core.Reflection.AssemblyLoader.LoadAssembly(System.String)">
463
<summary>Loads an assembly.</summary>
464
<param name="fileName">The assembly filename.</param>
465
<returns>The assembly object.</returns>
466
<remarks>This method loads an assembly into memory. If you
467
use Assembly.Load or Assembly.LoadFrom the assembly file locks.
468
This method doesn't lock the assembly file.</remarks>
470
<member name="M:NDoc.Core.Reflection.AssemblyLoader.ResolveAssembly(System.Object,System.ResolveEventArgs)">
472
Resolves the location and loads an assembly not found by the system.
474
<remarks>The CLR will take care of loading Framework and GAC assemblies.
475
<p>The resolution process uses the following heuristic</p>
477
<param name="sender">the sender of the event</param>
478
<param name="args">event arguments</param>
479
<returns>the loaded assembly, null, if not found</returns>
481
<member name="M:NDoc.Core.Reflection.AssemblyLoader.LoadAssemblyFrom(System.String,System.String)">
483
Search for and load the specified assembly in a set of directories.
484
This will optionally search recursively.
486
<param name="fullName">
487
Fully qualified assembly name. If not empty, the full name of each assembly found is
488
compared to this name and the assembly is accepted only, if the names match.
490
<param name="fileName">The name of the assembly.</param>
491
<returns>The assembly, or null if not found.</returns>
493
<member name="M:NDoc.Core.Reflection.AssemblyLoader.LoadAssemblyFrom(System.String,System.String,System.String,System.Boolean)">
495
Search for and load the specified assembly in a given directory.
496
This will optionally search recursively into sub-directories if requested.
498
<param name="path">The directory to look in.</param>
499
<param name="fullName">
500
Fully qualified assembly name. If not empty, the full name of each assembly found is
501
compared to this name and the assembly is accepted only, if the names match.
503
<param name="fileName">The name of the assembly.</param>
504
<param name="includeSubDirs">true, search subdirectories.</param>
505
<returns>The assembly, or null if not found.</returns>
507
<member name="M:NDoc.Core.Reflection.AssemblyLoader.IsAssemblyNameEquivalent(System.String,System.String)">
512
<member name="P:NDoc.Core.Reflection.AssemblyLoader.SearchedDirectories">
514
Directories Searched for assemblies.
517
<member name="P:NDoc.Core.Reflection.AssemblyLoader.UnresolvedAssemblies">
519
Assemblies that could not be resolved.
522
<member name="T:NDoc.Core.AssemblySlashDoc">
523
<summary>Represents the path to an assembly and its associated documentation comment XML file.</summary>
524
<remarks>Documentation comment XML files are known colloquially as <i>"SlashDoc"</i> files as they produced
525
by the Microsoft C# compiler when the /doc command-line option is specified. The format of these files is detailed in
526
the ECMA C# Specification (Appendix E).
527
See <see href="http://www.ecma-international.org/publications/standards/Ecma-334.htm">here</see> for further details.
530
<member name="M:NDoc.Core.AssemblySlashDoc.#ctor">
531
<overloads>Initializes a new instance of the <see cref="T:NDoc.Core.AssemblySlashDoc"/> class.</overloads>
532
<summary>Initializes a blank instance of the <see cref="T:NDoc.Core.AssemblySlashDoc"/> class.</summary>
534
<member name="M:NDoc.Core.AssemblySlashDoc.#ctor(System.String,System.String)">
535
<summary>Initializes a new instance of the <see cref="T:NDoc.Core.AssemblySlashDoc"/> class
536
with the specified Assembly and SlashDoc paths.</summary>
537
<param name="assemblyFilename">An assembly filename.</param>
538
<param name="slashDocFilename">A documentation comment XML filename.</param>
540
<member name="P:NDoc.Core.AssemblySlashDoc.Assembly">
542
Gets or sets the path to an assembly file.
544
<value>A <see cref="T:NDoc.Core.FilePath"/> representing the path to an assembly.</value>
546
<member name="P:NDoc.Core.AssemblySlashDoc.SlashDoc">
548
Gets or sets the path to a documentation comment XML file.
550
<value>A <see cref="T:NDoc.Core.FilePath"/> representing the path to a documentation comment XML file.</value>
552
<member name="T:NDoc.Core.AssemblySlashDocCollection">
554
Represents a collection of assemblies and their associated documentation comment XML files.
557
<member name="M:NDoc.Core.AssemblySlashDocCollection.Add(NDoc.Core.AssemblySlashDoc)">
559
Adds the specified <see cref="T:NDoc.Core.AssemblySlashDoc"/> object to the collection.
561
<param name="assySlashDoc">The <see cref="T:NDoc.Core.AssemblySlashDoc"/> to add to the collection.</param>
562
<exception cref="T:System.ArgumentNullException"><paramref name="assySlashDoc"/> is a <see langword="null"/>.</exception>
564
If the path of the <see cref="P:NDoc.Core.AssemblySlashDoc.Assembly"/>
565
in <paramref name="assySlashDoc"/> matches one already existing in the collection, the
566
operation is silently ignored.
569
<member name="M:NDoc.Core.AssemblySlashDocCollection.AddRange(System.Collections.ICollection)">
571
Adds the elements of an <see cref="T:System.Collections.ICollection"/> to the end of the collection.
573
<param name="c">The <see cref="T:System.Collections.ICollection"/> whose elements should be added to the end of the collection.
574
The collection itself cannot be a <see langword="null"/>.</param>
575
<exception cref="T:System.ArgumentNullException"><paramref name="c"/> is a <see langword="null"/>.</exception>
579
<member name="M:NDoc.Core.AssemblySlashDocCollection.Remove(NDoc.Core.AssemblySlashDoc)">
581
Removes the first occurence of a specific <see cref="T:NDoc.Core.AssemblySlashDoc"/> from the collection.
583
<param name="assySlashDoc">The <see cref="T:NDoc.Core.AssemblySlashDoc"/> to remove from the collection.</param>
584
<exception cref="T:System.ArgumentNullException"><paramref name="assySlashDoc"/> is a <see langword="null"/>.</exception>
586
Elements that follow the removed element move up to occupy the vacated spot and the indexes of the elements that are moved are also updated.
589
<member name="M:NDoc.Core.AssemblySlashDocCollection.Contains(NDoc.Core.AssemblySlashDoc)">
590
<overloads>Determines whether the collection contains a specified element.</overloads>
592
Determines whether the collection contains the specified <see cref="T:NDoc.Core.AssemblySlashDoc"/>.
594
<param name="assySlashDoc">The <see cref="T:NDoc.Core.AssemblySlashDoc"/> to locate in the collection.</param>
595
<returns><see langword="true"/> if the collection contains the specified <see cref="T:NDoc.Core.AssemblySlashDoc"/>,
596
otherwise <see langword="false"/>.</returns>
598
<member name="M:NDoc.Core.AssemblySlashDocCollection.Contains(System.String)">
600
Determines whether the collection contains a specified assembly path.
602
<param name="path">The assembly path to locate in the collection.</param>
603
<returns><see langword="true"/> if the collection contains the specified path,
604
otherwise <see langword="false"/>.</returns>
605
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is a <see langword="null"/>.</exception>
606
<remarks>Path comparison is case-insensitive.</remarks>
608
<member name="M:NDoc.Core.AssemblySlashDocCollection.ReadXml(System.Xml.XmlReader)">
610
Loads <see cref="T:NDoc.Core.AssemblySlashDoc"/> details from an <see cref="T:System.Xml.XmlReader"/>.
612
<param name="reader">
613
<exception cref="T:NDoc.Core.DocumenterException">The <i>location</i> attribute is missing or is an empty string</exception>
614
An open <see cref="T:System.Xml.XmlReader"/> positioned before, or on, the <b><assemblies></b> element.</param>
616
The expected format is is follows
617
<code escaped="true">
619
<assembly location="relative or fixed path" documentation="relative or fixed path"/>
623
<para>If the <i>location</i> attribute is missing or an empty string an exception will be thrown.</para>
624
<para>If the <i>documentation</i> attribute is missing or an empty string it will be silently ignored.</para>
627
<member name="M:NDoc.Core.AssemblySlashDocCollection.WriteXml(System.Xml.XmlWriter)">
629
Saves <see cref="T:NDoc.Core.AssemblySlashDoc"/> details to an <see cref="T:System.Xml.XmlWriter"/>.
631
<param name="writer">An open <see cref="T:System.Xml.XmlWriter"/>.</param>
633
The persisted format is is follows
634
<code escaped="true">
636
<assembly location="relative or fixed path" documentation="relative or fixed path"/>
642
<member name="P:NDoc.Core.AssemblySlashDocCollection.Item(System.Int32)">
644
Gets or sets the <see cref="T:NDoc.Core.AssemblySlashDoc"/> at the specified index.
646
<param name="index">The zero-based index of the <see cref="T:NDoc.Core.AssemblySlashDoc"/> to get or set.</param>
647
<value>The <see cref="T:NDoc.Core.AssemblySlashDoc"/> at the specified index</value>
648
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is not a valid index
649
in the collection.</exception>
650
<exception cref="T:System.ArgumentNullException">set <i>value</i> is a <see langword="null"/>.</exception>
652
<member name="T:NDoc.Core.Reflection.AssemblyXmlDocCache">
657
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.#ctor">
659
Creates a new instance of the <see cref="T:NDoc.Core.Reflection.AssemblyXmlDocCache"/> class.
662
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.Flush">
667
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.CacheDocFile(System.String)">
669
Populates cache from the given file.
671
<param name="fileName">Fully-qualified filename of xml file with which to populate the cache.</param>
673
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.CacheDocs(System.Xml.XmlTextReader)">
675
Cache the xmld docs into a hashtable for faster access.
677
<param name="reader">An XMLTextReader containg the docs the cache</param>
679
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.PreprocessDoc(System.String,System.String)">
681
Preprocess documentation before placing it in the cache.
683
<param name="id">Member name 'id' to which the docs belong</param>
684
<param name="doc">A string containing the members documentation</param>
685
<returns>processed doc string</returns>
687
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.CleanupNodes(System.String,System.Xml.XmlNodeList)">
689
strip out redundant newlines and spaces from documentation.
691
<param name="id">member</param>
692
<param name="nodes">list of nodes</param>
694
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.FixupCodeTag(System.Xml.XmlNode)">
696
Remove leading spaces from code tag contents.
698
<param name="node">a code tag node</param>
700
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.ProcessSeeLinks(System.String,System.Xml.XmlNodeList)">
702
Add 'nolink' attributes to self referencing or duplicate see tags.
704
<param name="id">current member name 'id'</param>
705
<param name="nodes">list of top-level nodes</param>
709
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.MarkupSeeLinks(System.Collections.Hashtable@,System.String,System.Xml.XmlNode)">
711
Search tags for duplicate or self-referencing see links.
713
<param name="linkTable">A table of previous links.</param>
714
<param name="id">current member name 'id'</param>
715
<param name="node">an Xml Node containing a doc tag</param>
717
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.GetDoc(System.String)">
719
Gets Xml documentation for the given ID
721
<param name="memberId">The ID of the item for which documentation is required</param>
722
<returns>a string containg the Xml documentation</returns>
724
<member name="M:NDoc.Core.Reflection.AssemblyXmlDocCache.HasExcludeTag(System.String)">
726
Returns whether a member has an exclude tag
728
<param name="memberId">ID to check</param>
729
<returns>true if the member has an exclude tag, otherwise false</returns>
731
<member name="T:NDoc.Core.PropertyGridUI.AttributesEditor">
733
Class which implements a custom UITypeEditor for attributes.
736
<member name="M:NDoc.Core.PropertyGridUI.AttributesEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
738
Handler called when editing a value.
740
<param name="context">Context</param>
741
<param name="provider">Provider</param>
742
<param name="value">Current Value</param>
743
<returns>New value</returns>
745
<member name="M:NDoc.Core.PropertyGridUI.AttributesEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
747
Returns the edit style for the type.
749
<param name="context">Context</param>
750
<returns>Edit Style</returns>
752
<member name="T:NDoc.Core.PropertyGridUI.AttributesForm">
754
A form to build attributes filter criteria.
757
<member name="F:NDoc.Core.PropertyGridUI.AttributesForm.Value">
759
Contains the updated value, if the user clicked OK.
762
<member name="F:NDoc.Core.PropertyGridUI.AttributesForm.AttributesToShow">
764
Structure which holds all the attributes
767
<member name="F:NDoc.Core.PropertyGridUI.AttributesForm.components">
769
Required designer variable.
772
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.#ctor(System.Object)">
774
Creates and initialize a new AttributesForm object.
776
<param name="val"></param>
778
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.Dispose(System.Boolean)">
780
Clean up any resources being used.
783
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.InitializeComponent">
785
Required method for Designer support - do not modify
786
the contents of this method with the code editor.
789
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.UpdateAttributes">
791
Helper function which updates the attributes list
794
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.UpdateProperties">
796
Helper function which udpates the properties list
799
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.listAttributes_SelectedIndexChanged(System.Object,System.EventArgs)">
801
Event handler called when a new attribute gets selected.
803
<param name="sender">Sender</param>
804
<param name="e">Event argument</param>
806
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.Add_Click(System.Object,System.EventArgs)">
808
Event handler called when the ADD button is clicked.
810
<param name="sender">Sender</param>
811
<param name="e">Event argument</param>
813
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.Delete_Click(System.Object,System.EventArgs)">
815
Event handler called when the DELETE button is clicked.
817
<param name="sender">Sender</param>
818
<param name="e">Event argument</param>
820
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.Edit_Click(System.Object,System.EventArgs)">
822
Event handler called when the EDIT button is clicked.
824
<param name="sender">Sender</param>
825
<param name="e">Event argument</param>
827
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.AddProp_Click(System.Object,System.EventArgs)">
829
Event handler called when the ADD (of the property list) is clicked.
831
<param name="sender">Sender</param>
832
<param name="e">Event argument</param>
834
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.EditProp_Click(System.Object,System.EventArgs)">
836
Event handler called when the EDIT (of the property list) is clicked.
838
<param name="sender">Sender</param>
839
<param name="e">Event argument</param>
841
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.DeleteProp_Click(System.Object,System.EventArgs)">
843
Event handler called when the DELETE (of the property list) is clicked.
845
<param name="sender">Sender</param>
846
<param name="e">Event argument</param>
848
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.listProperties_SelectedIndexChanged(System.Object,System.EventArgs)">
850
Event handler called when a new item in the property list gets selected.
852
<param name="sender">Sender</param>
853
<param name="e">Event argument</param>
855
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.buttonOK_Click(System.Object,System.EventArgs)">
857
Event handler called when the OK button is clicked.
859
<param name="sender">Sender</param>
860
<param name="e">Event argument</param>
862
<member name="T:NDoc.Core.PropertyGridUI.AttributesForm.AttributeToShow">
864
Class which holds information about an attribute.
867
<member name="M:NDoc.Core.PropertyGridUI.AttributesForm.AttributeToShow.#ctor">
869
Creates an empty AttributeToShow object
872
<member name="F:NDoc.Core.PropertyGridUI.AttributesForm.AttributeToShow.PropertiesToShow">
877
<member name="P:NDoc.Core.PropertyGridUI.AttributesForm.AttributeToShow.Name">
882
<member name="T:NDoc.Core.BaseDocumenter">
883
<summary>Provides an abstract base class for documenters.</summary>
885
This is an <see langword="abstract"/> base class for NDoc Documenters.
886
It provides default implementations of all the methods required by the <see cref="T:NDoc.Core.IDocumenter"/> interface.
887
It also provides some basic properties which are shared by all documenters.
890
<member name="T:NDoc.Core.IDocumenter">
891
<summary>Represents a class capable of generating documentation from a given assembly and /doc file.</summary>
893
<member name="M:NDoc.Core.IDocumenter.Clear">
894
<summary>Resets the documenter to a clean state.</summary>
896
<member name="M:NDoc.Core.IDocumenter.CanBuild(NDoc.Core.Project,System.Boolean)">
897
<summary>Checks to make sure the documenter can perform a
899
<param name="project">The project that would be built.</param>
900
<param name="checkInputOnly">When true, don't check for output
901
file locking.</param>
902
<remarks>This is for people who like to leave their CHMs open.</remarks>
903
<returns>null if the documenter can build; otherwise a message
904
describing why it can't build</returns>
906
<member name="M:NDoc.Core.IDocumenter.CanBuild(NDoc.Core.Project)">
908
Checks if the documentation output file(s) exist.
910
<param name="project">The project that generated the documentation.</param>
911
<returns>True if the documentation can be viewed.</returns>
913
<member name="M:NDoc.Core.IDocumenter.Build(NDoc.Core.Project)">
914
<summary>Builds the documentation.</summary>
915
<remarks>The compiler does not currently allow namespaces to documented.</remarks>
917
<member name="M:NDoc.Core.IDocumenter.View">
918
<summary>Spawns a new process to view the generated documentation.</summary>
919
<exception cref="T:System.IO.FileNotFoundException">
920
Thrown if the main output file does not exist.</exception>
922
<member name="P:NDoc.Core.IDocumenter.Name">
923
<summary>Gets the display name for the documenter.</summary>
925
<member name="P:NDoc.Core.IDocumenter.DevelopmentStatus">
927
The development status (alpha, beta, stable) of this documenter.
930
<member name="E:NDoc.Core.IDocumenter.DocBuildingStep">
932
Raised to update the overall percent complete value and the current step name.
935
<member name="E:NDoc.Core.IDocumenter.DocBuildingProgress">
937
Raised to update the current step's percent complete value.
940
<member name="P:NDoc.Core.IDocumenter.MainOutputFile">
942
Returns the documenter's main output file path.
945
<member name="P:NDoc.Core.IDocumenter.Config">
946
<summary>Gets or sets the documenter's config object.</summary>
947
<remarks>This can be put inside a PropertyGrid for editing by the user.</remarks>
949
<member name="M:NDoc.Core.BaseDocumenter.#ctor(System.String)">
950
<summary>Initializes a new instance of the <see cref="T:NDoc.Core.BaseDocumenter"/> class.</summary>
951
<param name="name">The display name of this documenter.</param>
953
<member name="M:NDoc.Core.BaseDocumenter.CompareTo(System.Object)">
954
<summary>Compares the currrent document to another documenter.</summary>
956
<member name="M:NDoc.Core.BaseDocumenter.View">
957
<summary>See <see cref="M:NDoc.Core.IDocumenter.View">IDocumenter.View</see>.</summary>
959
<member name="M:NDoc.Core.BaseDocumenter.OnDocBuildingStep(System.Int32,System.String)">
960
<summary>Raises the <see cref="E:NDoc.Core.BaseDocumenter.DocBuildingStep"/> event.</summary>
961
<param name="step">The overall percent complete value.</param>
962
<param name="label">A description of the work currently beeing done.</param>
964
<member name="M:NDoc.Core.BaseDocumenter.OnDocBuildingProgress(System.Int32)">
965
<summary>Raises the <see cref="E:NDoc.Core.BaseDocumenter.DocBuildingProgress"/> event.</summary>
966
<param name="progress">Percentage progress value</param>
968
<member name="M:NDoc.Core.BaseDocumenter.Clear">
969
<summary>See <see cref="M:NDoc.Core.IDocumenter.Clear">IDocumenter.Clear</see>.</summary>
971
<member name="M:NDoc.Core.BaseDocumenter.CanBuild(NDoc.Core.Project)">
972
<summary>See <see cref="M:NDoc.Core.IDocumenter.CanBuild(NDoc.Core.Project,System.Boolean)">IDocumenter.CanBuild</see>.</summary>
974
<member name="M:NDoc.Core.BaseDocumenter.CanBuild(NDoc.Core.Project,System.Boolean)">
975
<summary>See <see cref="M:NDoc.Core.IDocumenter.CanBuild(NDoc.Core.Project,System.Boolean)">CanBuild</see>.</summary>
977
<member name="M:NDoc.Core.BaseDocumenter.Build(NDoc.Core.Project)">
978
<summary>See <see cref="M:NDoc.Core.IDocumenter.Build(NDoc.Core.Project)">IDocumenter.Build</see>.</summary>
980
<member name="P:NDoc.Core.BaseDocumenter.DevelopmentStatus">
982
Specifies the development status (alpha, beta, stable) of a documenter.
985
As implemented in this class, this always returns <see cref="T:NDoc.Core.DocumenterDevelopmentStatus">Stable</see>.
986
<note type="inheritinfo">Documenters should override this if they are not yet stable...</note>
989
<member name="P:NDoc.Core.BaseDocumenter.Config">
990
<summary>See <see cref="P:NDoc.Core.IDocumenter.Config">IDocumenter.Config</see>.</summary>
992
<member name="P:NDoc.Core.BaseDocumenter.Name">
993
<summary>Gets the display name of this documenter.</summary>
995
<member name="P:NDoc.Core.BaseDocumenter.MainOutputFile">
996
<summary>See <see cref="P:NDoc.Core.IDocumenter.MainOutputFile">IDocumenter.MainOutputFile</see>.</summary>
998
<member name="E:NDoc.Core.BaseDocumenter.DocBuildingStep">
999
<summary>See <see cref="E:NDoc.Core.IDocumenter.DocBuildingStep">IDocumenter.DocBuildingStep</see>.</summary>
1001
<member name="E:NDoc.Core.BaseDocumenter.DocBuildingProgress">
1002
<summary>See <see cref="E:NDoc.Core.IDocumenter.DocBuildingProgress">IDocumenter.DocBuildingProgress</see>.</summary>
1004
<member name="T:NDoc.Core.BaseDocumenterConfig">
1005
<summary>Provides an abstract base class for documenter configurations.</summary>
1007
This is a base class for NDoc Documenter Configs.
1008
It implements all the methods required by the <see cref="T:NDoc.Core.IDocumenterConfig"/> interface.
1009
It also provides some basic properties which are shared by all configs.
1012
<member name="T:NDoc.Core.IDocumenterConfig">
1013
<summary>Specifies the methods that are common to all documenter configs.</summary>
1015
<member name="M:NDoc.Core.IDocumenterConfig.SetProject(NDoc.Core.Project)">
1016
<summary>Associates the config with a project.</summary>
1017
<remarks>Changes to the config will notify the project so that
1018
it can be marked as modified and saved.</remarks>
1020
<member name="M:NDoc.Core.IDocumenterConfig.GetProperties">
1021
<summary>Gets a list of property names.</summary>
1022
<returns>An enumerable list of property names.</returns>
1024
<member name="M:NDoc.Core.IDocumenterConfig.SetValue(System.String,System.String)">
1025
<summary>Sets the value of a property.</summary>
1026
<param name="name">The name of the property.</param>
1027
<param name="value">The value of the property.</param>
1029
<member name="M:NDoc.Core.IDocumenterConfig.Read(System.Xml.XmlReader)">
1030
<summary>Reads the previously serialized state of the documenter into memory.</summary>
1031
<param name="reader">An XmlReader positioned on a documenter element.</param>
1032
<remarks>This method uses reflection to set all of the public properties in the documenter.</remarks>
1034
<member name="M:NDoc.Core.IDocumenterConfig.Write(System.Xml.XmlWriter)">
1035
<summary>Writes the current state of the documenter to the specified XmlWrtier.</summary>
1036
<param name="writer">An XmlWriter.</param>
1037
<remarks>This method uses reflection to serialize all of the public properties in the documenter.</remarks>
1039
<member name="M:NDoc.Core.BaseDocumenterConfig.#ctor(System.String)">
1040
<summary>Initializes a new instance of the <see cref="T:NDoc.Core.BaseDocumenterConfig"/> class.</summary>
1042
<member name="M:NDoc.Core.BaseDocumenterConfig.SetProject(NDoc.Core.Project)">
1043
<summary>Associates this config with a <see cref="P:NDoc.Core.BaseDocumenterConfig.Project"/>.</summary>
1044
<param name="project">A <see cref="P:NDoc.Core.BaseDocumenterConfig.Project"/> to associate with this config.</param>
1046
<member name="M:NDoc.Core.BaseDocumenterConfig.SetDirty">
1047
<summary>Sets the <see cref="P:NDoc.Core.Project.IsDirty"/> property on the <see cref="P:NDoc.Core.BaseDocumenterConfig.Project"/>.</summary>
1049
<member name="M:NDoc.Core.BaseDocumenterConfig.GetProperties">
1050
<summary>Gets an enumerable list of <see cref="T:System.Reflection.PropertyInfo"/> objects representing the properties of this config.</summary>
1051
<remarks>properties are represented by <see cref="T:System.Reflection.PropertyInfo"/> objects.</remarks>
1053
<member name="M:NDoc.Core.BaseDocumenterConfig.SetValue(System.String,System.String)">
1055
Sets the value of a named config property.
1057
<param name="name">The name of the property to set.</param>
1058
<param name="value">A string representation of the desired property value.</param>
1059
<remarks>Property name matching is case-insensitive.</remarks>
1061
<member name="M:NDoc.Core.BaseDocumenterConfig.Write(System.Xml.XmlWriter)">
1062
<summary>Writes the current state of the config to the specified <see cref="T:System.Xml.XmlWriter"/>.</summary>
1063
<param name="writer">An open <see cref="T:System.Xml.XmlWriter"/>.</param>
1065
This method uses reflection to serialize the public properties in the config.
1067
A property will <b>not</b> be persisted if,
1068
<list type="bullet">
1069
<item>The value is equal to the default value, or</item>
1070
<item>The string representation of the value is an empty string, or</item>
1071
<item>The property has a Browsable(false) attribute, or</item>
1072
<item>The property has a NonPersisted attribute.</item>
1077
<member name="M:NDoc.Core.BaseDocumenterConfig.Read(System.Xml.XmlReader)">
1078
<summary>Loads config details from the specified <see cref="T:System.Xml.XmlReader"/>.</summary>
1079
<param name="reader">An <see cref="T:System.Xml.XmlReader"/> positioned on a <documenter> element.</param>
1080
<remarks>Each property found in the XML is loaded into current config using <see cref="M:NDoc.Core.BaseDocumenterConfig.ReadProperty(System.String,System.String)"/>.</remarks>
1082
<member name="M:NDoc.Core.BaseDocumenterConfig.ReadProperty(System.String,System.String)">
1084
Sets the value of a named property.
1086
<param name="name">A property name.</param>
1087
<param name="value">A string respesentation of the desired property value.</param>
1088
<returns>A string containing any messages generated while attempting to set the property.</returns>
1090
<member name="M:NDoc.Core.BaseDocumenterConfig.HandleUnknownPropertyType(System.String,System.String)">
1092
When overridden in a derived class, handles a property found by <see cref="M:NDoc.Core.BaseDocumenterConfig.Read(System.Xml.XmlReader)"/> which does not
1093
correspond to any property in the config object.
1095
<param name="name">The unknown property name.</param>
1096
<param name="value">A string representation of the desired property value.</param>
1097
<returns>A string containing any messages generated by the handler.</returns>
1099
As implemented in this class, no action is taken.
1100
<note type="inheritinfo">
1101
<para>If a handler can translate the unknown property, it can call the protected method
1102
<see cref="M:NDoc.Core.BaseDocumenterConfig.ReadProperty(System.String,System.String)"/> to process to translated name/value.</para>
1106
<member name="M:NDoc.Core.BaseDocumenterConfig.HandleUnknownPropertyValue(System.Reflection.PropertyInfo,System.String)">
1108
When overridden in a derived class, handles a unknown or invalid property value read by <see cref="M:NDoc.Core.BaseDocumenterConfig.Read(System.Xml.XmlReader)"/>.
1110
<param name="property">A valid Property name.</param>
1111
<param name="value">A string representation of the desired property value.</param>
1112
<returns>A string containing any messages generated by the handler.</returns>
1114
As implemented in this class, an error message is returned which details the
1115
property name, type and the invalid value.
1116
<note type="inheritinfo">
1117
<para>If a handler can translate the unknown value, it can call the protected method <see cref="M:NDoc.Core.BaseDocumenterConfig.ReadProperty(System.String,System.String)"/> to
1118
process to translated name/value.</para>
1122
<member name="P:NDoc.Core.BaseDocumenterConfig.Project">
1124
Gets the <see cref="P:NDoc.Core.BaseDocumenterConfig.Project"/> that this config is associated with, if any
1126
<value>The <see cref="P:NDoc.Core.BaseDocumenterConfig.Project"/> that this config is associated with, or a <see langword="null"/> if it is not associated with a project.</value>
1128
<member name="P:NDoc.Core.BaseDocumenterConfig.Name">
1130
Gets the display name of the documenter.
1133
<member name="P:NDoc.Core.BaseDocumenterConfig.UseNDocXmlFile">
1134
<summary>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.</summary>
1135
<remarks><para>When set, NDoc will use the specified XML file as
1136
input instead of reflecting the list of assemblies specified
1137
on the project.</para>
1138
<para>Very useful for debugging documenters. <b><i>Leave empty for normal usage.</i></b></para>
1141
<member name="P:NDoc.Core.BaseDocumenterConfig.CleanIntermediates">
1142
<summary>Gets or sets a value indicating whether to delete intermediate files after a successful build.</summary>
1145
<see langword="true"/> if intermediate files should be deleted after a successful build;
1146
otherwise, <see langword="false"/>. By default, the value of this property is <see langword="false"/>.</value>
1147
<para>For documenters that result in a compiled output, like the MSDN and VS.NET
1148
documenters, intermediate files include all of the HTML Help project files, as well as the generated
1149
HTML files.</para></remarks>
1151
<member name="T:NDoc.Core.NonPersistedAttribute">
1156
<member name="T:NDoc.Core.Reflection.BaseReflectionDocumenter">
1157
<summary>The base class for documenters which use the <see cref="T:NDoc.Core.Reflection.ReflectionEngine"/> to extract
1158
documentation from .Net assemblies.</summary>
1160
<member name="M:NDoc.Core.Reflection.BaseReflectionDocumenter.#ctor(System.String)">
1162
Initializes a new instance of the <see cref="T:NDoc.Core.Reflection.BaseReflectionDocumenter"/> class.
1164
<param name="name">Documenter Name</param>
1166
<member name="M:NDoc.Core.Reflection.BaseReflectionDocumenter.MakeXmlFile(NDoc.Core.Project,System.String)">
1168
Writes reflected metadata combined with the /doc comments to the
1172
This is performed in a separate <see cref="T:System.AppDomain"/>.
1175
<member name="M:NDoc.Core.Reflection.BaseReflectionDocumenter.MakeXml(NDoc.Core.Project)">
1177
Returns reflected metadata combined with the /doc comments.
1179
<remarks>This now evidently writes the string in utf-16 format (and
1180
says so, correctly I suppose, in the xml text) so if you write this string to a file with
1181
utf-8 encoding it will be unparseable because the file will claim to be utf-16
1182
but will actually be utf-8.</remarks>
1183
<returns>XML string</returns>
1185
This is performed in a separate <see cref="T:System.AppDomain"/>.
1188
<member name="T:NDoc.Core.Reflection.BaseReflectionDocumenterConfig">
1189
<summary>The base config class for documenters which use the <see cref="T:NDoc.Core.Reflection.ReflectionEngine"/> to extract
1190
documentation from .Net assemblies.</summary>
1192
<para>Generating the documentation consists of two high level steps:
1193
<list type="number">
1194
<item><description>Merging the /doc XML summary with reflected meta-data from the assemblies.</description></item>
1195
<item><description>Transforming that merged XML into the documentation (HTML for the MSDN and VS.NET documenters).</description></item>
1197
<para>The settings below govern how exactly the XML summary data is merged
1198
with the reflected meta-data and therefore govern what items will and will not
1199
appear in the final documentation.
1203
<member name="M:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.#ctor(System.String)">
1205
Initializes a new instance of the <see cref="T:NDoc.Core.Reflection.BaseReflectionDocumenterConfig"/> class.
1207
<param name="name">Documenter Name</param>
1209
<member name="M:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.HandleUnknownPropertyType(System.String,System.String)">
1213
<param name="name"></param>
1214
<param name="value"></param>
1217
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ReferencePaths">
1219
Gets or sets a collection of additional paths to search for reference assemblies.
1222
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowMissingSummaries">
1223
<summary>Gets or sets the ShowMissingSummaries property.</summary>
1224
<remarks>If this is true, all members without /doc <b><summary></b>
1225
comments will contain the phrase <font color="red">Missing Documentation</font> in the
1226
generated documentation.</remarks>
1228
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowMissingRemarks">
1229
<summary>Gets or sets the ShowMissingRemarks property.</summary>
1230
<remarks>If this is true, all members without /doc <b><remarks></b>
1231
comments will contain the phrase <font color="red">Missing Documentation</font> in the
1232
generated documentation.</remarks>
1234
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowMissingParams">
1235
<summary>Gets or sets the ShowMissingParams property.</summary>
1236
<remarks>If this is true, all parameters without /doc <b><param></b>
1237
comments will contain the phrase <font color="red">Missing Documentation</font> in the
1238
generated documentation.</remarks>
1240
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowMissingReturns">
1241
<summary>Gets or sets the ShowMissingReturns property.</summary>
1242
<remarks>If this is true, all members without /doc <b><returns></b>
1243
comments will contain the phrase <font color="red">Missing Documentation</font> in the
1244
generated documentation.</remarks>
1246
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowMissingValues">
1247
<summary>Gets or sets the ShowMissingValues property.</summary>
1248
<remarks>If this is true, all properties without /doc <b><value></b>
1249
comments will contain the phrase <font color="red">Missing Documentation</font> in the
1250
generated documentation.</remarks>
1252
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentInheritedMembers">
1253
<summary>Gets or sets the DocumentInheritedMembers property.</summary>
1254
<remarks>Determines what types of inherited members are documented.
1255
Normally, only inherited instance members are documented.
1258
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentInheritedFrameworkMembers">
1259
<summary>Gets or sets the DocumentInheritedFrameworkMembers property.</summary>
1260
<remarks>If true, members inherited from .Net framework classes will be documented.
1263
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentExplicitInterfaceImplementations">
1264
<summary>Gets or sets the DocumentInternals property.</summary>
1265
<remarks>If this is true, members which explicitly implement interfaces will
1266
be included in the documentation. Normally, these members are not documented.</remarks>
1268
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentInternals">
1269
<summary>Gets or sets the DocumentInternals property.</summary>
1270
<remarks>If this is true, types and members marked as internal will
1271
be included in the documentation. Normally, internal items are not documented.</remarks>
1273
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentProtected">
1274
<summary>Gets or sets the DocumentProtected property.</summary>
1275
<remarks>If this is true, protected members will be included in the
1276
documentation. Since protected members of non-internal types can be
1277
accessed outside of an assembly, this is true by default.</remarks>
1279
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentSealedProtected">
1280
<summary>Gets or sets the DocumentSealedProtected property.</summary>
1281
<remarks>Turn this flag on to document protected members of sealed classes.
1282
<b>DocumentProtected</b> must be turned on, too.</remarks>
1284
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentPrivates">
1285
<summary>Gets or sets the DocumentPrivates property.</summary>
1287
<para>If this is true, types and members marked as private will
1288
be included in the documentation.</para>
1289
<para>Normally private items are not documented. This is useful
1290
when use NDoc to create documentation intended for internal use.</para></remarks>
1292
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentProtectedInternalAsProtected">
1293
<summary>Gets or sets the DocumentProtectedInternalAsProtected property.</summary>
1294
<remarks>If this is true, NDoc will treat "protected internal" members as "protected" only.</remarks>
1296
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentEmptyNamespaces">
1297
<summary>Gets or sets the DocumentPrivates property.</summary>
1298
<remarks>If this is true, empty namespaces will be included in the documentation.
1299
Normally, empty namespaces are not documented.</remarks>
1301
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.SkipNamespacesWithoutSummaries">
1302
<summary>Gets or sets the SkipNamespacesWithoutSummaries property.</summary>
1303
<remarks>Setting this property to true , NDoc will not document namespaces
1304
that don't have an associated namespace summary.</remarks>
1306
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.EditorBrowsableFilter">
1307
<summary>Specifies the level of filtering on the EditorBrowsable attribute.</summary>
1308
<remarks><para>Sets the level of filtering to apply on types/members marked with the <b>EditorBrowsable</b> attribute.
1309
<b>Warning: enabling this filter might result in invalid links in the documentation.</b></para>
1310
<para>As of version 1.3 of NDoc, the <b><exclude/></b> tag is the preferred mechanism for
1311
suppressing the documentation of types or members.</para></remarks>
1313
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.AssemblyVersionInfo">
1314
<summary>Gets or sets the AssemblyVersion property.</summary>
1315
<remarks>Determines what type of Assembly Version information is documented.
1318
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.CopyrightText">
1319
<summary>Gets or sets the CopyrightText property.</summary>
1320
<remarks>A textual copyright notice that will be included with each topic.</remarks>
1322
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.CopyrightHref">
1323
<summary>Gets or sets the CopyrightHref property.</summary>
1324
<remarks>The URI of a copyright notice. A link to this URI will be included
1325
with each topic.</remarks>
1327
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.FeedbackEmailAddress">
1328
<summary>Gets or sets the FeedbackEmailAddress property.</summary>
1329
<remarks>If an email address is supplied, a <b>mailto</b> link
1330
will be placed at the bottom of each page, pointing to this address.</remarks>
1332
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.UseNamespaceDocSummaries">
1333
<summary>Gets or sets the UseNamespaceDocSummaries property.</summary>
1334
<remarks>If true, the documenter will look for a class with the name
1335
<b>NamespaceDoc</b> in each namespace. The summary from that class
1336
will then be used as the namespace summary. The class itself will not
1337
show up in the resulting documentation output.
1338
<para>You may want to use <b>#if</b> ... <b>#endif</b>
1339
together with conditional compilation constants to
1340
exclude the <b>NamespaceDoc</b> classes from release build assemblies.</para></remarks>
1342
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.AutoPropertyBackerSummaries">
1343
<summary>Gets or sets the AutoPropertyBackerSummaries property.</summary>
1344
<remarks>If true, the documenter will automatically add a summary
1345
for fields which look like they back (hold the value for) a
1346
property. The summary is only added if there is no existing summary,
1347
which gives you a way to opt out of this behavior in particular cases.
1348
Currently the naming conventions supported are such that
1349
fields <b>_Length</b> and <b>length</b> will be inferred to back property <b>Length</b>.</remarks>
1351
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.AutoDocumentConstructors">
1352
<summary>Gets or sets the AutoDocumentConstructors property.</summary>
1353
<remarks>Turning this flag on will enable automatic summary
1354
documentation for default constructors. If no summary for a parameter-less
1355
constructor is present, the default constructor summary of
1356
<b>Initializes a new instance of the CLASSNAME class</b> is inserted.</remarks>
1358
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.Preliminary">
1359
<summary>Get/set the Preliminary preoperty</summary>
1361
<para>If true, NDoc will mark every topic as being preliminary documentation.
1362
Each topic will include a notice that the documentation is preliminary</para>
1363
<para>The default notice is <font color="red">[This is preliminary documentation
1364
and subject to change.]</font></para></remarks>
1366
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.SdkDocVersion">
1367
<summary>Gets or sets the LinkToSdkDocVersion property.</summary>
1368
<remarks>Specifies to which version of the .NET Framework SDK documentation the links to system types will be pointing.</remarks>
1370
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.SdkDocLanguage">
1371
<summary>Gets or sets the SdkDocLanguage property.</summary>
1372
<remarks>Specifies to which Language of the .NET Framework SDK documentation the links to system types will be pointing.</remarks>
1374
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentAttributes">
1375
<summary>Gets or sets whether or not to document the attributes.</summary>
1376
<remarks>Set this to true to output the attributes of the types/members
1377
in the syntax portion of topics.</remarks>
1379
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentInheritedAttributes">
1380
<summary>Gets or sets whether or not to document the attributes inherited from base types.</summary>
1381
<remarks>Set this to true to output the attributes of the base types/members
1382
in the syntax portion of topics.</remarks>
1384
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.ShowTypeIdInAttributes">
1385
<summary>Gets or sets whether or not to show the TypeId property in attributes.</summary>
1386
<remarks>Set this to true to output the <b>TypeId</b> property in the attributes.</remarks>
1388
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.DocumentedAttributes">
1389
<summary>Gets or sets which attributes should be documented.</summary>
1390
<remarks><para>When <b>DocumentAttributes</b> is set to true, this specifies
1391
which attributes/property are visible. Empty to show all. </para>
1392
<para>Format: '<attribute-name-starts-with>,<property-to-show>,<property-to-show>|
1393
<attribute-name-starts-with>,<property-to-show>,<property-to-show>|(etc...)'.</para></remarks>
1395
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.IncludeDefaultThreadSafety">
1396
<summary>Gets or sets the IncludeDefaultThreadSafety property.</summary>
1397
<remarks>When true, typs that do not have an explicit <threadsafety>
1398
tag will include thread safety documentation corresponding to StaticMembersDefaultToSafe
1399
and InstanceMembersDefaultToSafe.
1402
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.StaticMembersDefaultToSafe">
1403
<summary>Gets or sets the StaticMembersDefaultToSafe property.</summary>
1404
<remarks>When true, types that do not have an explicit <threadsafety>
1405
tag will default to being safe for accessing static members across threads.
1406
(ignored if IncludeDefaultThreadSafety is false)</remarks>
1408
<member name="P:NDoc.Core.Reflection.BaseReflectionDocumenterConfig.InstanceMembersDefaultToSafe">
1409
<summary>Gets or sets the InstanceMembersDefaultToSafe property.</summary>
1410
<remarks>When true, types that do not have an explicit <threadsafety>
1411
tag will default to being safe for accessing instance members across threads.
1412
(ignored if IncludeDefaultThreadSafety is false)</remarks>
1414
<member name="T:NDoc.Core.Reflection.EditorBrowsableFilterLevel">
1416
Defines the levels of filtering on the EditorBrowsable attribute.
1419
<member name="F:NDoc.Core.Reflection.EditorBrowsableFilterLevel.Off">
1420
<summary>No filtering.</summary>
1422
<member name="F:NDoc.Core.Reflection.EditorBrowsableFilterLevel.HideNever">
1423
<summary>Hide members flagged with EditorBrowsableState.Never.</summary>
1425
<member name="F:NDoc.Core.Reflection.EditorBrowsableFilterLevel.HideAdvanced">
1426
<summary>Hide members flagged with EditorBrowsableState.Never or EditorBrowsableState.Advanced.</summary>
1428
<member name="T:NDoc.Core.Reflection.SdkVersion">
1430
Defines a version of the .NET Framework documentation.
1433
<member name="F:NDoc.Core.Reflection.SdkVersion.SDK_v1_0">
1434
<summary>The SDK version 1.0.</summary>
1436
<member name="F:NDoc.Core.Reflection.SdkVersion.SDK_v1_1">
1437
<summary>The SDK version 1.1.</summary>
1439
<member name="T:NDoc.Core.Reflection.SdkLanguage">
1441
Defines a language version of the .NET Framework documentation.
1444
<member name="F:NDoc.Core.Reflection.SdkLanguage.en">
1449
<member name="F:NDoc.Core.Reflection.SdkLanguage.fr">
1454
<member name="F:NDoc.Core.Reflection.SdkLanguage.de">
1459
<member name="F:NDoc.Core.Reflection.SdkLanguage.it">
1464
<member name="F:NDoc.Core.Reflection.SdkLanguage.ja">
1469
<member name="F:NDoc.Core.Reflection.SdkLanguage.ko">
1474
<member name="F:NDoc.Core.Reflection.SdkLanguage.es">
1479
<member name="T:NDoc.Core.Reflection.DocumentedInheritedMembers">
1481
Defines the type of inherited members to document.
1484
<member name="F:NDoc.Core.Reflection.DocumentedInheritedMembers.None">
1489
<member name="F:NDoc.Core.Reflection.DocumentedInheritedMembers.Instance">
1494
<member name="F:NDoc.Core.Reflection.DocumentedInheritedMembers.InstanceAndStatic">
1496
Instance and Static Members
1499
<member name="T:NDoc.Core.Reflection.AssemblyVersionInformationType">
1501
Defines the type of version information to document.
1504
<member name="F:NDoc.Core.Reflection.AssemblyVersionInformationType.None">
1509
<member name="F:NDoc.Core.Reflection.AssemblyVersionInformationType.AssemblyVersion">
1511
AssemblyVersion Attrribute.
1513
This is the standard /.Net version information specified in the AssemblyVersionAttribute.
1517
<member name="F:NDoc.Core.Reflection.AssemblyVersionInformationType.AssemblyFileVersion">
1519
AssemblyFileVersion Attribute
1521
This is the file version specified in the AssemblyFileVersion attribute, as opposed to the /.Net standard Assembly Version.
1523
<para>This type of version information is useful if an Assembly is to installed in the GAC, and the developer need to avoid side-by-side versioning issues, but wishes to provide build version information...
1527
<member name="T:NDoc.Core.DocumenterException">
1528
<summary>Represents an exception thrown when attempting to build documentation.</summary>
1530
<member name="M:NDoc.Core.DocumenterException.#ctor(System.String)">
1531
<summary>Initializes a new instance of the <see cref="T:NDoc.Core.DocumenterException"/> class with the specified message.</summary>
1532
<param name="message">The message to display when the exception is thrown.</param>
1534
<member name="M:NDoc.Core.DocumenterException.#ctor(System.String,System.Exception)">
1535
<summary>Initializes a new instance of the <see cref="T:NDoc.Core.DocumenterException"/> class
1536
with a specified error message and a reference to the
1537
inner exception that is the root cause of this exception.</summary>
1538
<param name="message">The error message that explains the reason for the exception.</param>
1539
<param name="inner">An instance of Exception that is the cause of the current Exception.
1540
If inner is non-null, then the current Exception is raised in a catch block handling the inner exception.</param>
1542
<member name="M:NDoc.Core.DocumenterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
1544
required to serialize across appdomain boundry
1547
<member name="T:NDoc.Core.EmbeddedResources">
1548
<summary>Utilties to help reading and writing embedded resources.</summary>
1549
<remarks>This is used to access the stylesheets.</remarks>
1551
<member name="M:NDoc.Core.EmbeddedResources.WriteEmbeddedResources(System.Reflection.Assembly,System.String,System.String)">
1552
<summary>Writes all the embedded resources with the specified prefix to disk.</summary>
1553
<param name="assembly">The assembly containing the embedded resources.</param>
1554
<param name="prefix">The prefix to search for.</param>
1555
<param name="directory">The directory to write the resources to.</param>
1557
<member name="M:NDoc.Core.EmbeddedResources.WriteEmbeddedResource(System.Reflection.Assembly,System.String,System.String,System.String)">
1558
<summary>Writes an embedded resource to disk.</summary>
1559
<param name="assembly">The assembly containing the embedded resource.</param>
1560
<param name="name">The name of the embedded resource.</param>
1561
<param name="directory">The directory to write the resource to.</param>
1562
<param name="filename">The filename of the resource on disk.</param>
1564
<member name="T:NDoc.Core.PropertyGridUI.EnumDescriptionConverter">
1566
EnumConverter supporting System.ComponentModel.DescriptionAttribute
1569
<member name="M:NDoc.Core.PropertyGridUI.EnumDescriptionConverter.GetEnumDescription(System.Enum)">
1571
Gets the Description of the given Enumeration value
1573
<param name="value">The enumeration value</param>
1574
<returns>The Description from the DescriptionAttribute attached to the value, otherwise the enumeration value's name</returns>
1576
<member name="M:NDoc.Core.PropertyGridUI.EnumDescriptionConverter.GetEnumDescription(System.Type,System.String)">
1578
Gets the Description of a named value in an Enumeration
1580
<param name="value">The type of the Enumeration</param>
1581
<param name="name">The name of the Enumeration value</param>
1582
<returns>The description, if any, else the passed name</returns>
1584
<member name="M:NDoc.Core.PropertyGridUI.EnumDescriptionConverter.GetEnumValue(System.Type,System.String)">
1586
Gets the value of an Enum, based on it's Description Attribute or named value
1588
<param name="value">The Enum type</param>
1589
<param name="description">The description or name of the element</param>
1590
<returns>The value, or the passed in description, if it was not found</returns>
1592
<member name="M:NDoc.Core.PropertyGridUI.EnumDescriptionConverter.#ctor(System.Type)">
1594
Constructs EnumDescriptionConverter for a given Enum
1596
<param name="type"></param>
1598
<member name="M:NDoc.Core.PropertyGridUI.EnumDescriptionConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
1600
<para>Converts the given value object to the specified type, using the specified context and culture information.</para>
1601
<para>This member overrides <see cref="M:System.ComponentModel.TypeConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)"/>.</para>
1603
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
1604
<param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
1605
<param name="value">The <see cref="T:System.Object"/> to convert.</param>
1606
<param name="destinationType">The <see cref="T:System.Type"/> to convert the <paramref name="value"/> parameter to.</param>
1607
<returns>An <see cref="T:System.Object"/> that represents the converted value.</returns>
1609
<member name="M:NDoc.Core.PropertyGridUI.EnumDescriptionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
1611
<para>Converts the given object to the type of this converter, using the specified context and culture information.</para>
1612
<para>This member overrides <see cref="M:System.ComponentModel.TypeConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)"/>.</para>
1614
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
1615
<param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
1616
<param name="value">The <see cref="T:System.Object"/> to convert.</param>
1617
<returns>An <see cref="T:System.Object"/> that represents the converted value.</returns>
1619
<member name="T:NDoc.Core.Reflection.ExternalXmlSummaryCache">
1621
Caches XML summaries.
1624
<member name="M:NDoc.Core.Reflection.ExternalXmlSummaryCache.#ctor(System.String)">
1626
Initializes a new instance of the <see cref="T:NDoc.Core.Reflection.ExternalXmlSummaryCache"/>
1630
<member name="M:NDoc.Core.Reflection.ExternalXmlSummaryCache.Flush">
1632
Flushes the <see cref="T:NDoc.Core.Reflection.ExternalXmlSummaryCache"/>.
1635
<member name="M:NDoc.Core.Reflection.ExternalXmlSummaryCache.AddXmlDoc(System.String)">
1637
Adds given XML document to the summary cache.
1639
<param name="xmlFileName">The filename of XML document to cache.</param>
1641
<member name="M:NDoc.Core.Reflection.ExternalXmlSummaryCache.GetXmlFor(System.Type)">
1643
Gets the xml documentation for the assembly of the specified type.
1646
<member name="M:NDoc.Core.Reflection.ExternalXmlSummaryCache.CacheSummaries(System.Xml.XmlTextReader)">
1648
Caches summaries for all members in XML documentation file.
1650
<param name="reader">XmlTextReader for XML Documentation</param>
1651
<remarks>If a member does not have a summary, a zero-length string is stored instead.</remarks>
1653
<member name="M:NDoc.Core.Reflection.ExternalXmlSummaryCache.PreprocessDoc(System.String,System.String)">
1655
Preprocess documentation before placing it in the cache.
1657
<param name="id">Member name 'id' to which the docs belong</param>
1658
<param name="doc">A string containing the members documentation</param>
1659
<returns>processed doc string</returns>
1661
<member name="M:NDoc.Core.Reflection.ExternalXmlSummaryCache.CleanupNodes(System.Xml.XmlNodeList)">
1663
strip out redundant newlines and spaces from documentation.
1665
<param name="nodes">list of nodes</param>
1667
<member name="M:NDoc.Core.Reflection.ExternalXmlSummaryCache.ProcessSeeLinks(System.String,System.Xml.XmlNodeList)">
1669
Add 'nolink' attributes to self referencing or duplicate see tags.
1671
<param name="id">current member name 'id'</param>
1672
<param name="nodes">list of top-level nodes</param>
1676
<member name="M:NDoc.Core.Reflection.ExternalXmlSummaryCache.MarkupSeeLinks(System.Collections.Hashtable@,System.String,System.Xml.XmlNode)">
1678
Search tags for duplicate or self-referencing see links.
1680
<param name="linkTable">A table of previous links.</param>
1681
<param name="id">current member name 'id'</param>
1682
<param name="node">an Xml Node containing a doc tag</param>
1684
<member name="M:NDoc.Core.Reflection.ExternalXmlSummaryCache.GetSummary(System.String,System.Type)">
1686
Returns the original summary for a member inherited from a specified type.
1688
<param name="memberID">The member ID to lookup.</param>
1689
<param name="declaringType">The type that declares that member.</param>
1690
<returns>The summary xml. If not found, returns an zero length string.</returns>
1692
<member name="T:NDoc.Core.PropertyGridUI.FilenameEditor">
1697
<member name="M:NDoc.Core.PropertyGridUI.FilenameEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
1699
Gets the edit style.
1701
<param name="context">Context.</param>
1704
<member name="M:NDoc.Core.PropertyGridUI.FilenameEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
1708
<param name="context">Context.</param>
1709
<param name="provider">Provider.</param>
1710
<param name="value">Value.</param>
1713
<member name="T:NDoc.Core.PropertyGridUI.FilenameEditor.FileDialogFilterAttribute">
1718
<member name="M:NDoc.Core.PropertyGridUI.FilenameEditor.FileDialogFilterAttribute.#ctor(System.String,System.String)">
1720
Define a filter for the UIFilenameEditor.
1722
<param name="title">File dialog title</param>
1723
<param name="filter">
1724
The filter to use in the file dialog in UIFilenameEditor.
1725
The following is an example of a filter string:
1726
"Text files (*.txt)|*.txt|All files (*.*)|*.*"</param>
1729
<member name="P:NDoc.Core.PropertyGridUI.FilenameEditor.FileDialogFilterAttribute.Title">
1735
<member name="P:NDoc.Core.PropertyGridUI.FilenameEditor.FileDialogFilterAttribute.Filter">
1737
The filter to use in the file dialog in UIFilenameEditor.
1741
The following is an example of a filter string:
1742
"Text files (*.txt)|*.txt|All files (*.*)|*.*"
1745
<member name="T:NDoc.Core.PropertyGridUI.FilenameEditor.SaveFileAttribute">
1747
Indicates that SaveFileDialog must be shown
1750
<member name="T:NDoc.Core.FilePath">
1755
<member name="T:NDoc.Core.PathItemBase">
1760
<member name="M:NDoc.Core.PathItemBase.op_Implicit(NDoc.Core.PathItemBase)~System.String">
1762
Explicit conversion of <see cref="T:NDoc.Core.PathItemBase"/> to <see cref="T:System.String"/>.
1764
<param name="path">The <see cref="T:NDoc.Core.PathItemBase"/> to convert.</param>
1765
<returns>A string containg the fully-qualified path contained in the passed <see cref="T:NDoc.Core.PathItemBase"/>.</returns>
1767
<member name="M:NDoc.Core.PathItemBase.#ctor">
1769
Initializes a new instance of the <see cref="T:NDoc.Core.PathItemBase"/> class.
1772
Initializes a new instance of the <see cref="T:NDoc.Core.PathItemBase"/> class.
1775
<member name="M:NDoc.Core.PathItemBase.#ctor(System.String)">
1777
Initializes a new instance of the <see cref="T:NDoc.Core.PathItemBase"/> class from a given path string.
1779
<param name="path">A relative or absolute path.</param>
1780
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is a <see langword="null"/>.</exception>
1781
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="path"/> is an empty string.</exception>
1783
If a <paramref name="path"/> is rooted, <see cref="P:NDoc.Core.PathItemBase.FixedPath"/> is set to <see langword="true"/>, otherwise
1784
is is set to <see langword="false"/>
1787
<member name="M:NDoc.Core.PathItemBase.#ctor(NDoc.Core.PathItemBase)">
1789
Initializes a new instance of the <see cref="T:NDoc.Core.PathItemBase"/> class from an existing <see cref="T:NDoc.Core.PathItemBase"/> instance.
1791
<param name="pathItemBase">An existing <see cref="T:NDoc.Core.PathItemBase"/> instance.</param>
1792
<exception cref="T:System.ArgumentNullException"><paramref name="pathItemBase"/> is a <see langword="null"/>.</exception>
1794
<member name="M:NDoc.Core.PathItemBase.ToString">
1797
<member name="M:NDoc.Core.PathItemBase.Equals(System.Object)">
1800
<member name="M:NDoc.Core.PathItemBase.op_Equality(NDoc.Core.PathItemBase,NDoc.Core.PathItemBase)">
1801
<summary>Equality operator.</summary>
1803
<member name="M:NDoc.Core.PathItemBase.op_Inequality(NDoc.Core.PathItemBase,NDoc.Core.PathItemBase)">
1804
<summary>Inequality operator.</summary>
1806
<member name="M:NDoc.Core.PathItemBase.GetHashCode">
1809
<member name="P:NDoc.Core.PathItemBase.BasePath">
1811
The base path for converting <see cref="T:NDoc.Core.PathItemBase"/> path to relative form.
1814
If the path has not been explicitly set, it defaults to the working directory.
1817
<member name="P:NDoc.Core.PathItemBase.Path">
1819
Gets or sets the fully qualified path.
1821
<value>The fully qualified path</value>
1822
<exception cref="T:System.ArgumentNullException">set <paramref name="value"/> is a <see langword="null"/>.</exception>
1823
<exception cref="T:System.ArgumentOutOfRangeException">set <paramref name="value"/> is an empty string.</exception>
1825
If the set path is not rooted, <see cref="P:NDoc.Core.PathItemBase.FixedPath"/> is set to <see langword="false"/>, otherwise
1826
it left at its current setting.
1829
<member name="P:NDoc.Core.PathItemBase.FixedPath">
1831
Gets or sets an indication whether the path should be saved as fixed or relative to the project file.
1834
if <see langword="true"/>, NDoc will save this as a Fixed path;
1835
otherwise, it will be saved as a path relative to the NDoc project file.
1838
<member name="T:NDoc.Core.PathItemBase.TypeConverter">
1843
<member name="T:NDoc.Core.PropertyGridUI.PropertySorter">
1848
<member name="M:NDoc.Core.PropertyGridUI.PropertySorter.GetPropertiesSupported(System.ComponentModel.ITypeDescriptorContext)">
1850
Gets whether the GetProperties method is supported.
1852
<param name="context">Context.</param>
1855
<member name="M:NDoc.Core.PropertyGridUI.PropertySorter.GetProperties(System.ComponentModel.ITypeDescriptorContext,System.Object,System.Attribute[])">
1857
Gets the properties.
1859
<param name="context">Context.</param>
1860
<param name="value">Value.</param>
1861
<param name="attributes">Attributes.</param>
1864
<member name="T:NDoc.Core.PropertyGridUI.PropertySorter.PropertyOrderPair">
1869
<member name="M:NDoc.Core.PropertyGridUI.PropertySorter.PropertyOrderPair.#ctor(System.String,System.Int32)">
1871
Creates a new <see cref="T:NDoc.Core.PropertyGridUI.PropertySorter.PropertyOrderPair"/> instance.
1873
<param name="name">Name.</param>
1874
<param name="order">Order.</param>
1876
<member name="M:NDoc.Core.PropertyGridUI.PropertySorter.PropertyOrderPair.CompareTo(System.Object)">
1880
<param name="obj">Obj.</param>
1883
<member name="P:NDoc.Core.PropertyGridUI.PropertySorter.PropertyOrderPair.Name">
1889
<member name="M:NDoc.Core.PathItemBase.TypeConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
1892
<member name="M:NDoc.Core.PathItemBase.TypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
1895
<member name="M:NDoc.Core.PathItemBase.TypeConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
1898
<member name="M:NDoc.Core.FilePath.#ctor">
1899
<summary>Initializes a new instance of the <see cref="T:NDoc.Core.FilePath"/> class.</summary>
1900
<overloads>Initializes a new instance of the <see cref="T:NDoc.Core.FilePath"/> class.</overloads>
1902
<member name="M:NDoc.Core.FilePath.#ctor(System.String)">
1903
<summary>Initializes a new instance of the <see cref="T:NDoc.Core.FilePath"/> class from a given path string.</summary>
1904
<param name="path">Path.</param>
1906
<member name="M:NDoc.Core.FilePath.#ctor(NDoc.Core.FilePath)">
1907
<summary>Initializes a new instance of the <see cref="T:NDoc.Core.FilePath"/> class from an existing <see cref="T:NDoc.Core.FilePath"/> instance.</summary>
1908
<param name="path">An existing <see cref="T:NDoc.Core.FilePath"/>.</param>
1910
<member name="P:NDoc.Core.FilePath.Path">
1913
<member name="T:NDoc.Core.FilePath.TypeConverter">
1918
<member name="M:NDoc.Core.FilePath.TypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
1921
<member name="M:NDoc.Core.FilePath.TypeConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
1924
<member name="T:NDoc.Core.FilePath.UIEditor">
1929
<member name="M:NDoc.Core.FilePath.UIEditor.#ctor">
1931
Creates a new <see cref="T:NDoc.Core.FilePath.UIEditor">FilePath.UIEditor</see> instance.
1934
<member name="M:NDoc.Core.FilePath.UIEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
1937
<member name="T:NDoc.Core.PropertyGridUI.FoldernameEditor">
1942
<member name="M:NDoc.Core.PropertyGridUI.FoldernameEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
1944
Gets the edit style.
1946
<param name="context">Context.</param>
1949
<member name="M:NDoc.Core.PropertyGridUI.FoldernameEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
1953
<param name="context">Context.</param>
1954
<param name="provider">Provider.</param>
1955
<param name="value">Value.</param>
1958
<member name="T:NDoc.Core.PropertyGridUI.FoldernameEditor.FolderDialogTitleAttribute">
1963
<member name="M:NDoc.Core.PropertyGridUI.FoldernameEditor.FolderDialogTitleAttribute.#ctor(System.String)">
1965
Define a title for the UIFoldernameEditor.
1967
<param name="title">Folder dialog title</param>
1970
<member name="P:NDoc.Core.PropertyGridUI.FoldernameEditor.FolderDialogTitleAttribute.Title">
1976
<member name="T:NDoc.Core.PropertyGridUI.FoldernameEditor.ExistingFolderOnlyAttribute">
1978
Indicates that only existing folders can be specified
1981
<member name="T:NDoc.Core.FolderPath">
1986
<member name="M:NDoc.Core.FolderPath.#ctor">
1988
Initializes a new instance of the <see cref="T:NDoc.Core.FolderPath"/> class.
1991
<member name="M:NDoc.Core.FolderPath.#ctor(System.String)">
1993
Initializes a new instance of the <see cref="T:NDoc.Core.FolderPath"/> class from a given path string.
1995
<param name="path">Path.</param>
1997
<member name="M:NDoc.Core.FolderPath.#ctor(NDoc.Core.FolderPath)">
1999
Initializes a new instance of the <see cref="T:NDoc.Core.FolderPath"/> class from an existing <see cref="T:NDoc.Core.FilePath"/> instance.
2001
<param name="path">An existing <see cref="T:NDoc.Core.FolderPath"/>.</param>
2003
<member name="M:NDoc.Core.FolderPath.ToString">
2006
<member name="P:NDoc.Core.FolderPath.Path">
2009
<member name="T:NDoc.Core.FolderPath.TypeConverter">
2014
<member name="M:NDoc.Core.FolderPath.TypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
2017
<member name="M:NDoc.Core.FolderPath.TypeConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
2020
<member name="T:NDoc.Core.FolderPath.UIEditor">
2025
<member name="M:NDoc.Core.FolderPath.UIEditor.#ctor">
2027
Creates a new <see cref="T:NDoc.Core.FolderPath.UIEditor">FolderPath.UIEditor</see> instance.
2030
<member name="M:NDoc.Core.FolderPath.UIEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
2033
<member name="T:NDoc.Core.ProgressArgs">
2035
Custom event arguments' class used by DocBuildingEventHandler.
2038
<member name="M:NDoc.Core.ProgressArgs.#ctor(System.Int32,System.String)">
2040
ProgressArgs default constructor.
2042
<param name="progress">Percentage value for a progress bar.</param>
2043
<param name="status">The label describing the current work beeing done.</param>
2045
<member name="P:NDoc.Core.ProgressArgs.Progress">
2047
Gets the percentage value.
2049
<value>A number between 0 and 100 corresponding to the percentage of work completed.</value>
2051
<member name="P:NDoc.Core.ProgressArgs.Status">
2053
Gets the current work label.
2055
<value>A short description of the current work beeing done.</value>
2057
<member name="T:NDoc.Core.DocumenterDevelopmentStatus">
2059
Specifies the development status of a documenter.
2062
<member name="F:NDoc.Core.DocumenterDevelopmentStatus.Alpha">
2063
<summary>Still in development, not really ready for anyone
2064
else to use except to provide feedback.</summary>
2066
<member name="F:NDoc.Core.DocumenterDevelopmentStatus.Beta">
2067
<summary>Ready for users to try out, with the understanding that
2068
bugs are likely.</summary>
2070
<member name="F:NDoc.Core.DocumenterDevelopmentStatus.Stable">
2071
<summary>Ready for use, or at least as stable as free
2072
software gets!</summary>
2074
<member name="F:NDoc.Core.DocumenterDevelopmentStatus.Obsolete">
2076
No longer actively maintained.
2079
<member name="T:NDoc.Core.DocBuildingEventHandler">
2081
Used by events raised by <see cref="T:NDoc.Core.IDocumenter"/> to notify doc building progress.
2083
<param name="sender">The source of the event.</param>
2084
<param name="e">An <c>ProgressArgs</c> that contains the event data.</param>
2086
<member name="T:NDoc.Core.PropertyGridUI.LangIdEditor">
2091
<member name="M:NDoc.Core.PropertyGridUI.LangIdEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
2095
<param name="context"></param>
2098
<member name="M:NDoc.Core.PropertyGridUI.LangIdEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
2102
<param name="context"></param>
2103
<param name="provider"></param>
2104
<param name="value"></param>
2107
<member name="M:NDoc.Core.PropertyGridUI.LangIdEditor.List_Click(System.Object,System.EventArgs)">
2111
<param name="sender"></param>
2112
<param name="args"></param>
2114
<member name="M:NDoc.Core.PropertyGridUI.LangIdEditor.FillInList(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Windows.Forms.ListBox,System.Int16)">
2118
<param name="context"></param>
2119
<param name="provider"></param>
2120
<param name="listBox"></param>
2121
<param name="value"></param>
2123
<member name="T:NDoc.Core.Namespaces">
2125
Summary description for Namespaces.
2128
<member name="M:NDoc.Core.Namespaces.op_Implicit(NDoc.Core.Namespaces)~System.Collections.SortedList">
2130
Allows a Namespaces collection to be treated as a SortedList
2132
<param name="namespaces">The Namespaces object to convert.</param>
2135
<member name="M:NDoc.Core.Namespaces.#ctor">
2137
Initializes a new instance of the <see cref="T:NDoc.Core.Namespaces"/> class.
2140
<member name="M:NDoc.Core.Namespaces.Read(System.Xml.XmlReader)">
2142
Reads namespace summaries from an XML document.
2144
<param name="reader">
2145
An open XmlReader positioned before the namespace elements.</param>
2147
<member name="M:NDoc.Core.Namespaces.Write(System.Xml.XmlWriter)">
2149
Writes namespace summaries to an XML document.
2151
<param name="writer">
2152
An open XmlWriter.</param>
2154
<member name="M:NDoc.Core.Namespaces.LoadNamespacesFromAssemblies(NDoc.Core.Project)">
2156
Loads the namespaces from assemblies.
2158
<param name="project">Project.</param>
2160
<member name="E:NDoc.Core.Namespaces.ContentsChanged">
2162
Raised when contents of collection change
2165
<member name="P:NDoc.Core.Namespaces.Item(System.String)">
2167
Gets or sets the namespace summary with the specified namespace name.
2171
<member name="P:NDoc.Core.Namespaces.NamespaceNames">
2172
<summary>Gets an enumerable list of namespace names.</summary>
2174
<member name="P:NDoc.Core.Namespaces.Count">
2175
<summary>The number of namespaces in the collection.</summary>
2177
<member name="T:NDoc.Core.PathUtilities">
2179
Utility Routines for path handling
2182
<member name="M:NDoc.Core.PathUtilities.AbsoluteToRelativePath(System.String,System.String)">
2184
Converts an absolute path to one relative to the given base directory path
2186
<param name="basePath">The base directory path</param>
2187
<param name="absolutePath">An absolute path</param>
2188
<returns>A path to the given absolute path, relative to the base path</returns>
2190
<member name="M:NDoc.Core.PathUtilities.RelativeToAbsolutePath(System.String,System.String)">
2192
Converts a given base and relative path to an absolute path
2194
<param name="basePath">The base directory path</param>
2195
<param name="relativePath">A path to the base directory path</param>
2196
<returns>An absolute path</returns>
2198
<member name="T:NDoc.Core.Project">
2199
<summary>Represents an NDoc project.</summary>
2201
<member name="M:NDoc.Core.Project.#ctor">
2202
<summary>Initializes a new instance of the <see cref="T:NDoc.Core.Project"/> class.</summary>
2204
<member name="F:NDoc.Core.Project._referencePaths">
2206
A collection of directories that will be probed when attempting to load assemblies.
2209
<member name="M:NDoc.Core.Project.GetFullPath(System.String)">
2211
Combines the specified path with the <see cref="P:NDoc.Core.Project.BaseDirectory"/> of
2212
the <see cref="T:NDoc.Core.Project"/> to form a full path to file or directory.
2214
<param name="path">The relative or absolute path.</param>
2219
<member name="M:NDoc.Core.Project.GetRelativePath(System.String)">
2221
Gets the relative path of the passed path with respect to the <see cref="P:NDoc.Core.Project.BaseDirectory"/> of
2222
the <see cref="T:NDoc.Core.Project"/>.
2224
<param name="path">The relative or absolute path.</param>
2229
<member name="F:NDoc.Core.Project._probePath">
2231
Holds the list of directories that will be scanned for documenters.
2234
<member name="M:NDoc.Core.Project.AppendProbePath(System.String)">
2236
Appends the specified directory to the documenter probe path.
2238
<param name="path">The directory to add to the probe path.</param>
2239
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
2240
<exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length <see cref="T:System.String"/>.</exception>
2243
The probe path is the list of directories that will be scanned for
2244
assemblies that have classes implementing <see cref="T:NDoc.Core.IDocumenter"/>.
2248
<member name="M:NDoc.Core.Project.FindDocumenters">
2250
Searches the module directory and all directories in the probe path
2251
for assemblies containing classes that implement <see cref="T:NDoc.Core.IDocumenter"/>.
2254
An <see cref="T:System.Collections.ArrayList"/> containing new instances of all the
2258
<member name="M:NDoc.Core.Project.FindDocumentersInPath(System.Collections.ArrayList,System.String)">
2260
Searches the specified directory for assemblies containing classes
2261
that implement <see cref="T:NDoc.Core.IDocumenter"/>.
2263
<param name="documenters">The collection of <see cref="T:NDoc.Core.IDocumenter"/> instances to fill.</param>
2264
<param name="path">The directory to scan for assemblies containing documenters.</param>
2266
<member name="M:NDoc.Core.Project.Read(System.String)">
2267
<summary>Reads an NDoc project file from disk.</summary>
2269
<member name="M:NDoc.Core.Project.GetDocumenter(System.String)">
2270
<summary>Retrieves a documenter by name.</summary>
2272
<member name="M:NDoc.Core.Project.Write(System.String)">
2273
<summary>Writes an NDoc project to a disk file.</summary>
2274
<remarks>A project is written to file in a 2 stage process;
2275
<list type="number">
2276
<item>The project data is serialised to an in-memory store.</item>
2277
<item>If no errors occured during serialization, the data is written to disk.</item>
2279
<p>This technique ensures that any fatal error during serialization will not cause a
2280
a corrupt or incomplete project file to be written to disk.</p>
2283
<member name="M:NDoc.Core.Project.Clear">
2284
<summary>Clears the project.</summary>
2286
<member name="P:NDoc.Core.Project.ProjectFile">
2288
Gets or sets the project file.
2292
<member name="E:NDoc.Core.Project.Modified">
2293
<summary>Raised when the project <see cref="P:NDoc.Core.Project.IsDirty"/> state changes from <see langword="false"/> to <see langword="true"/>.</summary>
2295
<member name="P:NDoc.Core.Project.IsDirty">
2296
<summary>Gets or sets a value indicating whether the contents of this project have been modified.</summary>
2297
<remarks>If a project is marked as 'dirty' then the GUI will ask to user if they wish to save the project before loading another, or exiting.</remarks>
2299
<member name="P:NDoc.Core.Project.SuspendDirtyCheck">
2301
Gets or sets a value indicating whether <see cref="P:NDoc.Core.Project.IsDirty"/> is updated when a project property is modifed.
2304
<see langword="true"/>, if changes to project properties should <b>not</b> update the value of <see cref="P:NDoc.Core.Project.IsDirty"/>; otherwise, <see langword="false"/>.
2306
<remarks>The default value of this property is <see langword="false"/>, however it is set to <see langword="true"/> during <see cref="M:NDoc.Core.Project.Read(System.String)"/> so a newly loaded project is not flagged as 'dirty'</remarks>
2308
<member name="P:NDoc.Core.Project.AssemblySlashDocs">
2310
Gets the collection of assemblies and documentation comment XML files in the project.
2312
<value>An <see cref="T:NDoc.Core.AssemblySlashDocCollection"/>.</value>
2314
<member name="P:NDoc.Core.Project.ReferencePaths">
2315
<summary>Gets a collection of directories that will be probed when attempting to load assemblies.</summary>
2317
<member name="P:NDoc.Core.Project.BaseDirectory">
2319
Gets the base directory used for relative references.
2322
The directory of the project file, or the current working directory
2323
if the project was not loaded from a project file.
2326
<member name="P:NDoc.Core.Project.Namespaces">
2328
Gets the project namespace summaries collection.
2332
<member name="P:NDoc.Core.Project.Documenters">
2334
Gets the list of available documenters.
2337
<member name="T:NDoc.Core.ProjectModifiedEventHandler">
2338
<summary>Handles Project <see cref="E:NDoc.Core.Project.Modified"/> events.</summary>
2340
<member name="T:NDoc.Core.CouldNotLoadAllAssembliesException">
2342
This exception is thrown when one or more assemblies can not be loaded.
2345
<member name="M:NDoc.Core.CouldNotLoadAllAssembliesException.#ctor">
2348
<member name="M:NDoc.Core.CouldNotLoadAllAssembliesException.#ctor(System.String)">
2351
<member name="M:NDoc.Core.CouldNotLoadAllAssembliesException.#ctor(System.String,System.Exception)">
2354
<member name="M:NDoc.Core.CouldNotLoadAllAssembliesException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
2357
<member name="T:NDoc.Core.DocumenterPropertyFormatException">
2359
This exception is thrown when there were invalid values in the documenter properties.
2362
<member name="M:NDoc.Core.DocumenterPropertyFormatException.#ctor">
2365
<member name="M:NDoc.Core.DocumenterPropertyFormatException.#ctor(System.String)">
2368
<member name="M:NDoc.Core.DocumenterPropertyFormatException.#ctor(System.String,System.Exception)">
2371
<member name="M:NDoc.Core.DocumenterPropertyFormatException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
2374
<member name="T:NDoc.Core.PropertyGridUI.PropertyOrderAttribute">
2379
<member name="M:NDoc.Core.PropertyGridUI.PropertyOrderAttribute.#ctor(System.Int32)">
2381
Creates a new <see cref="T:NDoc.Core.PropertyGridUI.PropertyOrderAttribute"/> instance.
2383
<param name="order">Order.</param>
2385
<member name="P:NDoc.Core.PropertyGridUI.PropertyOrderAttribute.Order">
2391
<member name="T:NDoc.Core.ReferencePath">
2393
A path to search for referenced assemblies.
2396
if <see cref="P:NDoc.Core.ReferencePath.IncludeSubDirectories"/> is set to <see langword="true"/>, subdirectories of
2397
<see cref="P:NDoc.Core.ReferencePath.Path"/> will also be searched.
2400
<member name="M:NDoc.Core.ReferencePath.#ctor">
2402
Initializes a new instance of the <see cref="T:NDoc.Core.ReferencePath"/> class.
2405
Initializes a new instance of the <see cref="T:NDoc.Core.ReferencePath"/> class.
2408
<member name="M:NDoc.Core.ReferencePath.#ctor(System.String)">
2410
Initializes a new instance of the <see cref="T:NDoc.Core.ReferencePath"/> class from a given path string.
2412
<param name="path">A relative or absolute path.</param>
2413
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is a <see langword="null"/>.</exception>
2414
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="path"/> is an empty string.</exception>
2416
If <paramref name="path"/> end with "**" then <see cref="P:NDoc.Core.ReferencePath.IncludeSubDirectories"/>
2417
will be set to <see langword="true"/>.
2420
<member name="M:NDoc.Core.ReferencePath.#ctor(NDoc.Core.ReferencePath)">
2422
Initializes a new instance of the <see cref="T:NDoc.Core.ReferencePath"/> class from an existing <see cref="T:NDoc.Core.ReferencePath"/> instance.
2424
<param name="refPath">An existing <see cref="T:NDoc.Core.ReferencePath"/> instance.</param>
2425
<exception cref="T:System.ArgumentNullException"><paramref name="refPath"/> is a <see langword="null"/>.</exception>
2427
<member name="M:NDoc.Core.ReferencePath.Equals(System.Object)">
2430
<member name="M:NDoc.Core.ReferencePath.op_Equality(NDoc.Core.ReferencePath,NDoc.Core.ReferencePath)">
2431
<summary>Equality operator.</summary>
2433
<member name="M:NDoc.Core.ReferencePath.op_Inequality(NDoc.Core.ReferencePath,NDoc.Core.ReferencePath)">
2434
<summary>Inequality operator.</summary>
2436
<member name="M:NDoc.Core.ReferencePath.GetHashCode">
2439
<member name="M:NDoc.Core.ReferencePath.ToString">
2442
<member name="P:NDoc.Core.ReferencePath.Path">
2444
Gets or sets the fully qualified path.
2446
<value>The fully qualified path</value>
2447
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is a <see langword="null"/>.</exception>
2448
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="path"/> is an empty string.</exception>
2451
If <paramref name="path"/> is not rooted, <see cref="P:NDoc.Core.PathItemBase.FixedPath"/> is set to <see langword="false"/>, otherwise
2452
it left at its current setting.
2455
If this property is set to a string that ends with "**" then <see cref="P:NDoc.Core.ReferencePath.IncludeSubDirectories"/>
2456
will be set to <see langword="true"/>.
2460
<member name="P:NDoc.Core.ReferencePath.IncludeSubDirectories">
2462
Gets or sets an indication whether to search subdirectories of the given path.
2465
if <see langword="true"/>, the assembly loader will search subdirectories; otherwise, it will only search given path.
2468
<member name="T:NDoc.Core.ReferencePath.TypeConverter">
2470
<see cref="T:NDoc.Core.ReferencePath.TypeConverter"/> to convert a string to an instance of <see cref="T:NDoc.Core.ReferencePath"/>.
2473
<member name="M:NDoc.Core.ReferencePath.TypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)">
2476
<member name="M:NDoc.Core.ReferencePath.TypeConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
2479
<member name="T:NDoc.Core.ReferencePath.UIEditor">
2484
<member name="M:NDoc.Core.ReferencePath.UIEditor.#ctor">
2486
Creates a new <see cref="T:NDoc.Core.ReferencePath.UIEditor">ReferencePath.UIEditor</see> instance.
2489
<member name="M:NDoc.Core.ReferencePath.UIEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
2492
<member name="T:NDoc.Core.ReferencePathCollection">
2494
Type safe collection class for <see cref="T:NDoc.Core.ReferencePath"/> objects.
2497
<para>Extends the base class <see cref="T:System.Collections.CollectionBase"/> to inherit base collection functionality.</para>
2498
<para>Implementation of <see cref="T:System.ComponentModel.ICustomTypeDescriptor"/> to provide customized type description.</para>
2501
<member name="M:NDoc.Core.ReferencePathCollection.Add(NDoc.Core.ReferencePath)">
2503
Adds the specified <see cref="T:NDoc.Core.ReferencePath"/> object to the collection.
2505
<param name="refPath">The <see cref="T:NDoc.Core.ReferencePath"/> to add to the collection.</param>
2506
<exception cref="T:System.ArgumentNullException"><paramref name="refPath"/> is a <see langword="null"/>.</exception>
2508
If the path in <paramref name="refPath"/> matches one already existing in the collection, the
2509
operation is silently ignored.
2512
<member name="M:NDoc.Core.ReferencePathCollection.AddRange(System.Collections.ICollection)">
2514
Adds the elements of an <see cref="T:System.Collections.ICollection"/> to the end of the collection.
2516
<param name="c">The <see cref="T:System.Collections.ICollection"/> whose elements should be added to the end of the collection.
2517
The collection itself cannot be a <see langword="null"/>.</param>
2518
<exception cref="T:System.ArgumentNullException"><paramref name="c"/> is a <see langword="null"/>.</exception>
2520
<member name="M:NDoc.Core.ReferencePathCollection.Remove(NDoc.Core.ReferencePath)">
2522
Removes the first occurence of a specific <see cref="T:NDoc.Core.ReferencePath"/> from the collection.
2524
<param name="refPath">The <see cref="T:NDoc.Core.ReferencePath"/> to remove from the collection.</param>
2525
<exception cref="T:System.ArgumentNullException"><paramref name="refPath"/> is a <see langword="null"/>.</exception>
2527
Elements that follow the removed element move up to occupy the vacated spot and the indexes of the elements that are moved are also updated.
2530
<member name="M:NDoc.Core.ReferencePathCollection.Contains(System.String)">
2532
Determines whether the collection contains a specified path.
2534
<param name="path">The path to locate in the collection.</param>
2535
<returns><see langword="true"/> if the collection contains the specified path,
2536
otherwise <see langword="false"/>.</returns>
2537
<exception cref="T:System.ArgumentNullException"><paramref name="path"/> is a <see langword="null"/>.</exception>
2538
<remarks>Path comparison is case-insensitive.</remarks>
2540
<member name="M:NDoc.Core.ReferencePathCollection.WriteXml(System.Xml.XmlWriter)">
2542
Saves reference paths to an XmlWriter.
2544
<param name="writer">An open XmlWriter.</param>
2546
<member name="M:NDoc.Core.ReferencePathCollection.ReadXml(System.Xml.XmlReader)">
2548
Loads reference paths from an XMLReader.
2550
<param name="reader">
2551
An open XmlReader positioned before or on the referencePaths element.</param>
2553
<member name="M:NDoc.Core.ReferencePathCollection.System#ComponentModel#ICustomTypeDescriptor#GetProperties(System.Attribute[])">
2555
Called to get the properties of this type. Returns properties with certain
2556
attributes. this restriction is not implemented here.
2558
<param name="attributes"></param>
2561
<member name="P:NDoc.Core.ReferencePathCollection.Item(System.Int32)">
2563
Gets or sets the <see cref="T:NDoc.Core.ReferencePath"/> at the specified index.
2565
<param name="index">The zero-based index of the <see cref="T:NDoc.Core.ReferencePath"/> to get or set.</param>
2566
<value>The <see cref="T:NDoc.Core.ReferencePath"/> at the specified index</value>
2567
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is not a valid index
2568
in the collection.</exception>
2569
<exception cref="T:System.ArgumentNullException">set <i>value</i> is a <see langword="null"/>.</exception>
2571
<member name="T:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor">
2573
Summary description for CollectionPropertyDescriptor.
2576
<member name="M:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.#ctor(NDoc.Core.ReferencePathCollection,System.Int32)">
2579
<member name="M:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.CanResetValue(System.Object)">
2582
<member name="M:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.GetValue(System.Object)">
2585
<member name="M:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.ResetValue(System.Object)">
2588
<member name="M:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.ShouldSerializeValue(System.Object)">
2591
<member name="M:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.SetValue(System.Object,System.Object)">
2594
<member name="P:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.Attributes">
2597
<member name="P:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.ComponentType">
2600
<member name="P:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.DisplayName">
2603
<member name="P:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.Description">
2606
<member name="P:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.IsReadOnly">
2609
<member name="P:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.Name">
2612
<member name="P:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.PropertyType">
2615
<member name="P:NDoc.Core.ReferencePathCollection.ReferencePathCollectionPropertyDescriptor.Converter">
2618
<member name="T:NDoc.Core.ReferencePathCollection.ReferencePathCollectionEditor">
2623
<member name="M:NDoc.Core.ReferencePathCollection.ReferencePathCollectionEditor.#ctor">
2625
Creates a new <see cref="T:NDoc.Core.ReferencePathCollection.ReferencePathCollectionEditor"/> instance.
2628
<member name="M:NDoc.Core.ReferencePathCollection.ReferencePathCollectionEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
2632
<param name="context">Context.</param>
2633
<param name="provider">Provider.</param>
2634
<param name="value">Value.</param>
2637
<member name="M:NDoc.Core.ReferencePathCollection.ReferencePathCollectionEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
2639
Gets the edit style.
2641
<param name="context">Context.</param>
2644
<member name="T:NDoc.Core.ReferencePathCollectionEditorForm">
2646
Summary description for ReferencePathCollectionEditorForm.
2649
<member name="M:NDoc.Core.ReferencePathCollectionEditorForm.#ctor">
2651
Creates a new <see cref="T:NDoc.Core.ReferencePathCollectionEditorForm"/> instance.
2654
<member name="M:NDoc.Core.ReferencePathCollectionEditorForm.Dispose(System.Boolean)">
2656
Clean up any resources being used.
2659
<member name="M:NDoc.Core.ReferencePathCollectionEditorForm.InitializeComponent">
2661
Required method for Designer support - do not modify
2662
the contents of this method with the code editor.
2665
<member name="P:NDoc.Core.ReferencePathCollectionEditorForm.ReferencePaths">
2667
Gets or sets the reference paths collection to edit.
2671
<member name="T:NDoc.Core.PropertyGridUI.RuntimePropertyGrid">
2673
A PropertyGrid with context menu to <b>Reset</b> values and show/hide the <b>Description</b> pane.
2676
<member name="M:NDoc.Core.PropertyGridUI.RuntimePropertyGrid.#ctor">
2678
Creates a new instance of the RuntimePropertyGrid class
2681
<member name="P:NDoc.Core.PropertyGridUI.RuntimePropertyGrid.LabelWidth">
2683
Gets or sets the width of the label.
2687
<member name="T:NDoc.Core.Settings">
2689
This class manages read write access to application settings
2693
<member name="M:NDoc.Core.Settings.#ctor(System.String)">
2695
Creates a new instance of the <see cref="T:NDoc.Core.Settings"/> class.
2697
<param name="filePath">Path to serialized settings</param>
2699
<member name="M:NDoc.Core.Settings.Dispose">
2701
<see cref="M:System.IDisposable.Dispose"/>
2704
<member name="M:NDoc.Core.Settings.GetSetting(System.String,System.String,System.Boolean)">
2706
Retrieves the value of a setting
2708
<param name="section">The section name to store the list under</param>
2709
<param name="name">The name of the setting</param>
2710
<param name="defaultValue">The value to use if no setting is found</param>
2711
<returns>The stored setting or the default value if no stroed setting is found</returns>
2713
<member name="M:NDoc.Core.Settings.GetSetting(System.String,System.String,System.Int32)">
2715
Retrieves the value of a setting
2717
<param name="section">The section name to store the list under</param>
2718
<param name="name">The name of the setting</param>
2719
<param name="defaultValue">The value to use if no setting is found</param>
2720
<returns>The stored setting or the default value if no stroed setting is found</returns>
2722
<member name="M:NDoc.Core.Settings.GetSetting(System.String,System.String,System.String)">
2724
Retrieves the value of a setting
2726
<param name="section">The section name to store the list under</param>
2727
<param name="name">The name of the setting</param>
2728
<param name="defaultValue">The value to use if no setting is found</param>
2729
<returns>The stored setting or the default value if no stroed setting is found</returns>
2731
<member name="M:NDoc.Core.Settings.GetSetting(System.String,System.String,System.Object)">
2733
Retrieves the value of a setting
2735
<param name="section">The section name to store the list under</param>
2736
<param name="name">The name of the setting</param>
2737
<param name="defaultValue">The value to use if no setting is found</param>
2738
<returns>The stored setting or the default value if no stroed setting is found</returns>
2740
<member name="M:NDoc.Core.Settings.GetSettingList(System.String,System.String,System.Type,System.Collections.IList@)">
2742
Retrieves a list of settings. If the list cannot be found
2743
then no items are added
2745
<param name="section">The section name to store the list under</param>
2746
<param name="name">The name of the setting</param>
2747
<param name="itemType">The type of each setting in the list</param>
2748
<param name="list">A <see cref="T:System.Collections.IList"/> into which to put each item</param>
2750
<member name="M:NDoc.Core.Settings.SetSettingList(System.String,System.String,System.String,System.Collections.IList)">
2752
Stores a list of settings
2754
<param name="section">The section name to store the list under</param>
2755
<param name="name">The name of the setting</param>
2756
<param name="itemName">The name of each item in the list</param>
2757
<param name="list">The list</param>
2759
<member name="M:NDoc.Core.Settings.SetSetting(System.String,System.String,System.Boolean)">
2763
<param name="section">The section name to store the setting in</param>
2764
<param name="name">The name of the setting</param>
2765
<param name="val">The setting's value</param>
2767
<member name="M:NDoc.Core.Settings.SetSetting(System.String,System.String,System.Int32)">
2771
<param name="section">The section name to store the setting in</param>
2772
<param name="name">The name of the setting</param>
2773
<param name="val">The setting's value</param>
2775
<member name="M:NDoc.Core.Settings.SetSetting(System.String,System.String,System.String)">
2779
<param name="section">The section name to store the setting in</param>
2780
<param name="name">The name of the setting</param>
2781
<param name="val">The setting's value</param>
2782
<remarks>Passing an emtpy string removes the setting</remarks>
2784
<member name="M:NDoc.Core.Settings.SetSetting(System.String,System.String,System.Object)">
2788
<param name="section">The section name to store the setting in</param>
2789
<param name="name">The name of the setting</param>
2790
<param name="val">The setting's value</param>
2791
<remarks>Passing a null object removes the setting</remarks>
2793
<member name="M:NDoc.Core.Settings.RemoveSetting(System.String,System.String)">
2797
<param name="section">Setting section</param>
2798
<param name="name">Setting name</param>
2800
<member name="P:NDoc.Core.Settings.UserSettingsFile">
2802
The full path the the default user settings file
2805
<member name="P:NDoc.Core.Settings.MachineSettingsFile">
2807
The full path the the default machine settings file
2810
<member name="P:NDoc.Core.Settings.UserSettingsLocation">
2812
The path to the folder where the user specific settings file is stored
2815
<member name="P:NDoc.Core.Settings.MachineSettingsLocation">
2817
The path to the folder where the machine wide settings file is stored
2820
<member name="P:NDoc.Core.Settings.SettingsFolderName">
2822
Gets the name of the settings folder.
2826
<member name="T:NDoc.Core.Settings.NoPrologXmlWriter">
2828
This class is used to serialize objects without inserting
2829
xml prolog or doctype declarations
2832
<member name="T:NDoc.Core.PropertyGridUI.SimpleEdit">
2834
This is a dialog box to prompt for a name.
2837
<member name="F:NDoc.Core.PropertyGridUI.SimpleEdit.components">
2839
Required designer variable.
2842
<member name="M:NDoc.Core.PropertyGridUI.SimpleEdit.#ctor">
2844
Initializes a new instance of the <see cref="T:NDoc.Core.PropertyGridUI.SimpleEdit"/> form.
2847
<member name="M:NDoc.Core.PropertyGridUI.SimpleEdit.Dispose(System.Boolean)">
2849
Clean up any resources being used.
2852
<member name="M:NDoc.Core.PropertyGridUI.SimpleEdit.InitializeComponent">
2854
Required method for Designer support - do not modify
2855
the contents of this method with the code editor.
2858
<member name="F:NDoc.Core.PropertyGridUI.SimpleEdit.Value">
2860
Contains the value of the text box.
2863
<member name="M:NDoc.Core.PropertyGridUI.SimpleEdit.SimpleEdit_Load(System.Object,System.EventArgs)">
2865
Event handler called when the form is initialy loaded.
2867
<param name="sender"></param>
2868
<param name="e"></param>
2870
<member name="M:NDoc.Core.PropertyGridUI.SimpleEdit.buttonOK_Click(System.Object,System.EventArgs)">
2872
Event handler called when the user clicks the OK button.
2874
<param name="sender">Sender</param>
2875
<param name="e">Event arguments</param>
2877
<member name="T:NDoc.Core.TemplateWriter">
2879
Stream writer that parses a template file to write a new file.
2882
<member name="M:NDoc.Core.TemplateWriter.#ctor(System.String,System.IO.TextReader)">
2884
Initializes a new instance of the <see cref="T:NDoc.Core.TemplateWriter"/> class for the specified
2885
file on the specified path, using the specified template stream and using
2886
the default encoding and buffer size.
2888
<param name="outPath">The complete file path to write to.</param>
2889
<param name="template">The template's stream reader.</param>
2891
<member name="M:NDoc.Core.TemplateWriter.#ctor(System.IO.Stream,System.IO.TextReader)">
2893
Initializes a new instance of the <see cref="T:NDoc.Core.TemplateWriter"/> class for the specified
2894
stream, using the specified template stream and using the default encoding
2897
<param name="stream">The stream to write to.</param>
2898
<param name="template">The template's stream reader.</param>
2900
<member name="M:NDoc.Core.TemplateWriter.CopyToLine(System.String)">
2902
Copies the text lines form the template to the output stream
2903
until a specific line is found.
2905
<param name="toLine">The line text to search for.
2906
Must match exactly.</param>
2907
<returns><b>true</b> if the line was found, <b>false</b> if the
2908
end of the template stream was reached.</returns>
2910
<member name="M:NDoc.Core.TemplateWriter.CopyToEnd">
2912
Copies the text lines form the template to the output stream
2913
until the end of the template stream.
2916
<member name="M:NDoc.Core.TemplateWriter.Close">
2918
Closes the current StreamWriter and StreamReader.
2921
<member name="M:NDoc.Core.TemplateWriter.Dispose(System.Boolean)">
2923
Releases the unmanaged resources used by the TemplateWriter
2924
and optionally releases the managed resources.
2926
<param name="disposing"><b>true</b> to release both managed
2927
and unmanaged resources; <b>false</b> to release only
2928
unmanaged resources.</param>
2930
<member name="T:NDoc.Core.PropertyGridUI.TextEditor">
2932
Provides editing facilities for large blocks of text in the <see cref="T:System.Windows.Forms.PropertyGrid"/>.
2935
<member name="M:NDoc.Core.PropertyGridUI.TextEditor.#ctor">
2937
Creates a new instance of the <see cref="T:NDoc.Core.PropertyGridUI.TextEditor"/> class.
2940
<member name="M:NDoc.Core.PropertyGridUI.TextEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)">
2942
Edits the specified object's value using the editor style indicated by <see cref="M:NDoc.Core.PropertyGridUI.TextEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)"/>.
2944
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that can be used to gain additional context information.</param>
2945
<param name="provider">An <see cref="T:System.IServiceProvider"/> that this editor can use to obtain services.</param>
2946
<param name="value">The object to edit.</param>
2947
<returns>The new value of the object.</returns>
2949
<member name="M:NDoc.Core.PropertyGridUI.TextEditor.GetEditStyle(System.ComponentModel.ITypeDescriptorContext)">
2951
Gets the editor style used by the <see cref="M:NDoc.Core.PropertyGridUI.TextEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)"/> method.
2953
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that can be used to gain additional context information.</param>
2954
<returns>A <see cref="T:System.Drawing.Design.UITypeEditorEditStyle"/> value that indicates the style of editor used by <see cref="M:NDoc.Core.PropertyGridUI.TextEditor.EditValue(System.ComponentModel.ITypeDescriptorContext,System.IServiceProvider,System.Object)"/>.</returns>
2956
<member name="T:NDoc.Core.PropertyGridUI.TextEditorForm">
2958
Used in the conjunction with the <see cref="T:NDoc.Core.PropertyGridUI.TextEditor"/>, this form
2959
provides the user a larger interface with which to edit text.
2962
<member name="F:NDoc.Core.PropertyGridUI.TextEditorForm.components">
2964
Required designer variable.
2967
<member name="M:NDoc.Core.PropertyGridUI.TextEditorForm.#ctor">
2969
Creates a new instance of the <see cref="T:NDoc.Core.PropertyGridUI.TextEditorForm"/> form.
2972
<member name="M:NDoc.Core.PropertyGridUI.TextEditorForm.Dispose(System.Boolean)">
2974
Clean up any resources being used.
2977
<member name="M:NDoc.Core.PropertyGridUI.TextEditorForm.InitializeComponent">
2979
Required method for Designer support - do not modify
2980
the contents of this method with the code editor.
2983
<member name="P:NDoc.Core.PropertyGridUI.TextEditorForm.Value">
2985
Gets or sets the text to edit.
2987
<value>The text to edit.</value>
2989
<member name="T:NDoc.Core.ContentEventHandler">
2991
Handler for content events
2994
<member name="T:NDoc.Core.Workspace">
2996
The Workspace class manages the Output directory and its subfolders
2997
where help file content and project files are used to compile the
2998
final help collection
3001
<member name="F:NDoc.Core.Workspace.contentDir">
3003
The name of the directory where the html file are created
3006
<member name="F:NDoc.Core.Workspace.rootDir">
3008
The location of the workspace and files
3011
<member name="F:NDoc.Core.Workspace.cleanableFileTypes">
3013
These are the output file type extensions that will be cleaned
3016
<member name="M:NDoc.Core.Workspace.#ctor(System.String,System.String,System.String,System.String)">
3018
Creates a new instance of the <see cref="T:NDoc.Core.Workspace"/> class.
3020
<param name="root">The location to create the workspace</param>
3021
<param name="type">The type of workspace</param>
3022
<param name="contentDirName">The name of the sub folder where content will be placed</param>
3023
<param name="cleanableExtensions">A semi-colon delimited list of file extensions that can be deleted when cleaning
3024
the root folder of the workspace (*.ex1;*.ex2)</param>
3026
<member name="M:NDoc.Core.Workspace.Prepare">
3028
Prepares the workspace, by creating working and content directories
3031
<member name="M:NDoc.Core.Workspace.AddResourceDirectory(System.String)">
3033
Adds a sub directory to the resource directory
3035
<param name="dirName">The name of the sub directory</param>
3037
<member name="M:NDoc.Core.Workspace.RemoveResourceDirectory">
3039
Recursively deletes the ResourceDirectory
3042
<member name="M:NDoc.Core.Workspace.SaveOutputs(System.String)">
3044
Saves files mathing the specified filter from the build directory to the root directory
3046
<param name="filter">File filter to search for</param>
3048
<member name="M:NDoc.Core.Workspace.ImportProjectFiles(System.String)">
3050
Copies project resources into the workspace.
3051
Project files are files needed to compile the help file, but
3052
are not directly part of its content
3054
<param name="sourceDirectory">The path to the resources</param>
3056
<member name="M:NDoc.Core.Workspace.ImportProjectFiles(System.String,System.String)">
3058
Copies project resources into the workspace
3059
Project files are files needed to compile the help file, but
3060
are not directly part of its content
3062
<param name="sourceDirectory">The path to the resources</param>
3063
<param name="filter">File filter to use when selecting files to import</param>
3065
<member name="M:NDoc.Core.Workspace.ImportContentDirectory(System.String)">
3067
Recursively copies the contents of sourceDirectory into the workspace content,
3068
maintainng the same directory structure
3070
<param name="sourceDirectory">The directory to import</param>
3072
<member name="M:NDoc.Core.Workspace.OnContentDirectoryAdded(System.String)">
3074
Raises the <see cref="E:NDoc.Core.Workspace.ContentDirectoryAdded"/> event
3076
<param name="relativePath">Path relative to the workspace root</param>
3078
<member name="M:NDoc.Core.Workspace.GetRelativePath(System.IO.DirectoryInfo,System.IO.DirectoryInfo)">
3080
Return the relative path between two directories
3082
<param name="ancestor">The folder closest to the drive root</param>
3083
<param name="child">A folder that is a child of ancestor</param>
3086
<member name="M:NDoc.Core.Workspace.ImportContent(System.String)">
3088
Copies content into the workspace ContentDirectory
3090
<param name="sourceDirectory">The path to the content files</param>
3092
<member name="M:NDoc.Core.Workspace.ImportContent(System.String,System.String)">
3094
Copies content into the workspace ContentDirectory.
3095
Content are files that will be incorporated into the final help file
3097
<param name="sourceDirectory">The path to the xontent files</param>
3098
<param name="filter">File filter to use when selecting files to import</param>
3100
<member name="M:NDoc.Core.Workspace.OnContentFileAdded(System.String)">
3102
Raises the <see cref="E:NDoc.Core.Workspace.ContentFileAdded"/> event
3104
<param name="fileName">The name of the file added</param>
3106
<member name="M:NDoc.Core.Workspace.CleanIntermediates">
3108
Deletes the content of the <see cref="P:NDoc.Core.Workspace.WorkingDirectory"/>
3111
<member name="M:NDoc.Core.Workspace.Clean">
3113
Delets all output and intermediate files from the project workspace
3114
This will delete all the cleanable files in the root and remove the working directory
3117
<member name="E:NDoc.Core.Workspace.ContentDirectoryAdded">
3119
Event raised when a content directory is added
3122
<member name="E:NDoc.Core.Workspace.ContentFileAdded">
3124
Event raised when a content file is added
3127
<member name="P:NDoc.Core.Workspace.WorkingDirectoryName">
3129
The name of the directory where the compilation takes place
3132
<member name="P:NDoc.Core.Workspace.ContentDirectoryName">
3134
The name of the content directory
3137
<member name="P:NDoc.Core.Workspace.RootDirectory">
3139
The full path to the worksapce root.
3140
This is where project outputs will be saved when compilation
3144
<member name="P:NDoc.Core.Workspace.ContentDirectory">
3146
The full path of the help content files
3149
<member name="P:NDoc.Core.Workspace.WorkingDirectory">
3151
The the full path to the directory where the compilation will run
3154
<member name="P:NDoc.Core.Workspace.ResourceDirectory">
3156
The location where the xslt stylesheets will be unpacked
3159
<member name="T:NDoc.Core.XsltResourceResolver">
3161
Resolves URLs stored as embedded resources in an assembly.
3163
<remarks>for debugging purposes, it is possible to direct the resolver to look for the resources in a
3164
disk directory rather than extracting them from the assembly.
3165
This is especially useful as it allows the stylesheets to be changed
3166
and re-run without recompiling the assembly.</remarks>
3168
<member name="M:NDoc.Core.XsltResourceResolver.#ctor(System.String)">
3170
Creates a new instance of the <see cref="T:NDoc.Core.XsltResourceResolver"/> class.
3172
<param name="resourceBase">Either, the namespace of the embedded resources, or a file URI to a disk directory where the recources may be found.</param>
3174
<member name="M:NDoc.Core.XsltResourceResolver.ResolveUri(System.Uri,System.String)">
3176
Resolves the absolute URI from the base and relative URIs.
3178
<param name="baseUri">The base URI used to resolve the relative URI.</param>
3179
<param name="relativeUri">The URI to resolve. The URI can be absolute or relative. If absolute, this value effectively replaces the <paramref name="baseUri"/> value. If relative, it combines with the <paramref name="baseUri"/> to make an absolute URI.</param>
3180
<returns>A <see cref="T:System.Uri"/> representing the absolute URI or <see langword="null"/> if the relative URI can not be resolved.</returns>
3181
<remarks><paramref name="baseURI"/> is always <see langword="null"/> when this method is called from <see cref="M:System.Xml.Xsl.XslTransform.Load(System.Xml.XmlReader)">XslTransform.Load</see></remarks>
3183
<member name="M:NDoc.Core.XsltResourceResolver.GetEntity(System.Uri,System.String,System.Type)">
3185
Maps a URI to an object containing the actual resource.
3187
<param name="absoluteUri">The URI returned from <see cref="M:NDoc.Core.XsltResourceResolver.ResolveUri(System.Uri,System.String)"/>.</param>
3188
<param name="role">unused.</param>
3189
<param name="ofObjectToReturn">The type of object to return. The current implementation only returns <b>System.IO.Stream</b> or <b>System.Xml.XmlReader</b> objects.</param>
3192
<member name="P:NDoc.Core.XsltResourceResolver.ExtensibiltyStylesheet">
3194
User-defined Extensibility Stylesheet
3196
<value>fully-qualified filename of exstensibility stylesheet</value>
added
removed
selenium-remote-control-1.0.1-dist/selenium-remote-control-1.0.1/selenium-dotnet-client-driver-1.0.1/source/tools/ndoc/NDoc.Core.xml
