Open burnchar opened 3 months ago
Thank you for open-sourcing your documentation generator. It is so, so easy to use.
The only issue I have run into is in the DefaultDocumentationSections, so I thought I would report it here.
DefaultDocumentationSections is case-sensitive, but has inconsistent case.
Namespaces
seealso
summary
Parameters
Please consider making this case-insensitive.
0>DefaultDocumentation.targets(45,3): Error MSB4018 : The "DefaultDocumentationTask" task failed unexpectedly. System.Exception: Section 'Summary' not found:
<DefaultDocumentationSections>Title|Summary|Definition|TypeParameters|Parameters|EnumFields|Inheritance|Derived|Implement|EventType|FieldValue|value|returns|exception|example|remarks|seealso|Namespaces|Classes|Structs|Interfaces|Enums|Delegates|Constructors|Fields|Properties|Methods|Events|Operators</DefaultDocumentationSections>
Works: <DefaultDocumentationSections>Title|summary|Definition|TypeParameters|Parameters|EnumFields|Inheritance|Derived|Implement|EventType|FieldValue|value|returns|exception|example|remarks|seealso|Namespaces|Classes|Structs|Interfaces|Enums|Delegates|Constructors|Fields|Properties|Methods|Events|Operators</DefaultDocumentationSections>
<DefaultDocumentationSections>Title|summary|Definition|TypeParameters|Parameters|EnumFields|Inheritance|Derived|Implement|EventType|FieldValue|value|returns|exception|example|remarks|seealso|Namespaces|Classes|Structs|Interfaces|Enums|Delegates|Constructors|Fields|Properties|Methods|Events|Operators</DefaultDocumentationSections>
The only difference is the capitalization of "Summary", which seems very subtle.
Thank you for open-sourcing your documentation generator. It is so, so easy to use.
The only issue I have run into is in the DefaultDocumentationSections, so I thought I would report it here.
DefaultDocumentationSections is case-sensitive, but has inconsistent case.
Namespacesmust begin with a capital 'N'seealsomust be all lower-casesummarymust be all lower-caseParametersmust begin with a capital 'P'Please consider making this case-insensitive.
<DefaultDocumentationSections>Title|Summary|Definition|TypeParameters|Parameters|EnumFields|Inheritance|Derived|Implement|EventType|FieldValue|value|returns|exception|example|remarks|seealso|Namespaces|Classes|Structs|Interfaces|Enums|Delegates|Constructors|Fields|Properties|Methods|Events|Operators</DefaultDocumentationSections>Works:
<DefaultDocumentationSections>Title|summary|Definition|TypeParameters|Parameters|EnumFields|Inheritance|Derived|Implement|EventType|FieldValue|value|returns|exception|example|remarks|seealso|Namespaces|Classes|Structs|Interfaces|Enums|Delegates|Constructors|Fields|Properties|Methods|Events|Operators</DefaultDocumentationSections>The only difference is the capitalization of "Summary", which seems very subtle.