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

Namespace documentation #54

Open
kostiantxn opened this issue Dec 12, 2023 · 0 comments
Open

Namespace documentation #54

kostiantxn opened this issue Dec 12, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested
Milestone

Comments

@kostiantxn
Copy link
Collaborator

We should consider adding support for documentation for namespaces.

Unfortunately, in C# namespaces cannot have XML documentation. As an alternative, we could use something more convention-based. For example, define a file-scoped Namespace class and attach documentation to it:

namespace Summary;

/// <summary>
///     The core <c>Summary</c> namespace which defines pipelines
///     for parsing C# source code into <see cref="Doc"/> objects.
/// </summary>
file class Namespace;

We could also ignore C# restrictions, and attach documentation to the namespace regardless:

/// <summary>
///     The core <c>Summary</c> namespace which defines pipelines
///     for parsing C# source code into <see cref="Doc"/> objects.
/// </summary>
namespace Summary;

Given that we use static syntax analysis, we should still be able to extract the leading trivia for the namespace and convert it into proper namespace documentation.

@kostiantxn kostiantxn added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested labels Dec 12, 2023
@kostiantxn kostiantxn added this to the Backlog milestone Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant