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

API Reference: Add support for nested types #6

Merged
merged 13 commits into from
Dec 29, 2019

Conversation

ap0llo
Copy link
Owner

@ap0llo ap0llo commented Dec 8, 2019

Add support for generation documentation for nested types

  • Load nested types from assembly
  • Adjust TypeId to accommodate for nested types
  • Include defining type in type page
  • Include list of nested types in type page
  • Adjust page output path for nested types
  • Adjust XML docs parsing
  • Adjust CSharpDefinitionFormatter to render full name including surrounding types
  • Should nested types show up in the type list or just in the docs page of the declaring type?

Include nested types in types loaded from assemblies
Add support for nested types to TypeId and its derived types.
Adjust ToTypeId() extension methods to properly handle nested types
Place documentation for nested types into subdirectories of the
documentation of the declaring type.
Add examples of nested classes to demo project
Ignore non-public nested types
…nFormatter

Improve generated C# definition of flags enum values. When the enum
contains an "All" element (like e.g. AttributeTargets) and the value
matches, display just the exact match instead of a or expression of all
values.
When displaying individual flag values, exclude enum values unless they
are an exact match (e.g. do not always display 'AttributeTargets.All')
@ap0llo ap0llo force-pushed the features/apireference/nested-types-support branch from b35d4dc to 96e8ba8 Compare December 15, 2019 19:48
Add support for nested types to CSharpDefinitionFormatter
Show declaring type on documentation pages for nested types.
Add support for nested types to MemberIdParser.
Currently, MemberIdParser will only return the correct id for nested
types if the nested type is nested within a generic type.
Otherwise the id of a nested type and a top-level type have
the same format.
Add support for nested types to MemberIdParser.
For ids to be parsed correctly, a list of non-nested types needs to be specified.
Include list of nested types in type documentation
Show full name (including name of declaring type) in C# definition of nested types
Rewrite code that requires C# 8.0
@ap0llo ap0llo changed the title WIP: API Reference: Add support for nested types API Reference: Add support for nested types Dec 29, 2019
@ap0llo ap0llo merged commit 965c709 into master Dec 29, 2019
@ap0llo ap0llo deleted the features/apireference/nested-types-support branch December 29, 2019 12:16
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

Successfully merging this pull request may close these issues.

1 participant