documentation.HELP! Sandcastle XML Comments Documentation

Sandcastle XML Comments Guide

Sandcastle XML Comments

Table of contents

• Welcome
• License Agreement
• Walkthrough: Enabling and Using XML Comments
• Usage Notes
• Member ID Strings
• Namespace Comments
• External XML Comments Files
• Using NamespaceDoc and NamespaceGroupDoc Classes
• Section Elements
• event
• example
• exception
• param
• permission
• preliminary
• remarks
• returns
• revisionHistory
• seealso
• summary
• threadsafety
• typeparam
• value
• Block Elements
• code
• list
• note
• para
• Inline Elements
• c
• paramref
• see
• typeparamref
• Miscellaneous Elements
• AttachedEventComments
• AttachedPropertyComments
• Code Contract Elements
• conceptualLink
• exclude
• filterpriority
• include
• inheritdoc
• overloads
• token
• Frequently Asked Questions (FAQ)
• Links to Resources
• Making a Donation
• Version History
• Version 2015.10.10.0
• Version 2014.11.22.0
• Version 2014.5.31.0
• Version 2014.1.26.0
• Version 1.0.0.0
• Glossary
• XMLCommentsExamples
• GenericClass(T1, T2) Class
• GenericClass(T1, T2) Constructor
• GenericClass(T1, T2) Properties
• Property Property
• GenericClass(T1, T2) Methods
• GenericMethod(T3, T4) Method
• Method Method
• OnSomethingHappened Method
• GenericClass(T1, T2) Events
• SomethingHappened Event
• RevisionHistoryClass Class
• RevisionHistoryClass Constructor
• RevisionHistoryClass Properties
• Revision Property
• RevisionHistoryClass Methods
• ExampleMethod Method
• SampleClass Class
• SampleClass Properties
• SampleNumber Property
• SampleClass Methods
• AverageValues Method
• AverageValues Method (IEnumerable(Double))
• AverageValues Method (IEnumerable(Double), IEnumerable(Double))
• CallStoredProcedure Method
• ConceptualLinkExample Method
• DoSomething Method
• DoSomething Method
• DoSomething Method (Int32)
• DoSomething Method (String)
• DoSomething Method (Int32, String)
• FilterPriorityExample Method
• GetRandomNumber Method
• IncludeAllExample Method
• IncludeSectionsExample Method
• Increment Method
• MethodRequiringSpecificPermissions Method
• OnSomethingHappened Method
• ParagraphExample Method
• PerformAnAction Method
• PreliminaryExample Method
• ProcessText Method
• SeeElementExternalExample Method
• SeeLangWordExamples Method
• SummaryRemarksExample Method
• SumValues Method
• SumValues Method (IEnumerable(Int32))
• SumValues Method (IEnumerable(Int32), IEnumerable(Int32))
• TemporaryMethod Method
• TokenExample Method
• VariousListExamples Method
• VariousNoteExamples Method
• SampleClass Events
• SomethingHappened Event
• SampleClass Operators
• Addition Operator
• ThreadSafetyClass Class
• ThreadSafetyClass Constructor
• ThreadSafetyClass Methods
• InstanceMethod Method
• StaticMethod Method
• XMLCommentsExamples.DocumentationInheritance
• AttachedEventsAndPropertiesTest Class
• AttachedEventsAndPropertiesTest Methods
• AddItemActivateHandler Method
• GetIsBroughtIntoViewWhenSelected Method
• RemoveItemActivateHandler Method
• SetIsBroughtIntoViewWhenSelected Method
• AttachedEventsAndPropertiesTest Fields
• IsBroughtIntoViewWhenSelectedProperty Field
• ItemActivateEvent Field
• AttachedEventsAndPropertiesTest Attached Properties
• IsBroughtIntoViewWhenSelected Attached Property
• AttachedEventsAndPropertiesTest Attached Events
• ItemActivate Attached Event
• BaseInheritDoc Class
• BaseInheritDoc Constructor
• BaseInheritDoc Methods
• MethodWithExample Method
• MethodWithLotsOfComments Method
• MethodWithTwoExamples Method
• ToString Method
• CustomException Class
• CustomException Constructor
• CustomException Constructor
• CustomException Constructor (String)
• CustomException Constructor (SerializationInfo, StreamingContext)
• CustomException Constructor (String, Exception)
• CustomException Properties
• CustomException Methods
• CustomException Events
• DerivedClassWithInheritedDocs Class
• DerivedClassWithInheritedDocs Constructor
• DerivedClassWithInheritedDocs Methods
• MethodUsingSharedExample Method
• MethodWithExample Method
• MethodWithLotsOfComments Method
• MethodWithTwoExamples Method
• OverloadedMethod Method
• OverloadedMethod Method (String)
• OverloadedMethod Method (String, Int32)
• OverloadedMethod Method (String, String)
• ToString Method
• ExplicitImplementation Class
• ExplicitImplementation Constructor
• ExplicitImplementation Properties
• ICollection.Count Property
• ICollection.IsSynchronized Property
• ICollection.SyncRoot Property
• ExplicitImplementation Methods
• ICollection.CopyTo Method
• IEnumerable.GetEnumerator Method
• Clone Method
• SetDocumentation Structure
• SetDocumentation Properties
• Count Property
• IsReadOnly Property
• SetDocumentation Methods
• ICollection(Int32).Add Method
• IEnumerable.GetEnumerator Method
• Add Method
• Clear Method
• Contains Method
• CopyTo Method
• ExceptWith Method
• GetEnumerator Method
• IntersectWith Method
• IsProperSubsetOf Method
• IsProperSupersetOf Method
• IsSubsetOf Method
• IsSupersetOf Method
• Overlaps Method
• Remove Method
• SetEquals Method
• SymmetricExceptWith Method
• UnionWith Method

next page

Get in touch

Submit feedback about this site to:

• [email protected]