Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Case sensitive DefaultDocumentationSections #157

Open
burnchar opened this issue May 20, 2024 · 0 comments
Open

Case sensitive DefaultDocumentationSections #157

burnchar opened this issue May 20, 2024 · 0 comments

Comments

@burnchar
Copy link

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 must begin with a capital 'N'
  • seealso must be all lower-case
  • summary must be all lower-case
  • Parameters must begin with a capital 'P'

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>

The only difference is the capitalization of "Summary", which seems very subtle.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant