Skip to content

Add type params for class documentation. #5

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.

Sign up for GitHub

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

Open
Selectorsvt wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add type params for class documentation. #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b40b0ee
Add type params.
Oct 29, 2021
a5404c9
Add type params.
Oct 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/DotnetDocument/Configuration/DocumentationOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,11 @@ public ExtendedSummaryDocumentationOptions()
/// Gets or inits the value of the include inheritance
/// </summary>
public bool IncludeInheritance { get; init; } = true;

/// <summary>
/// Gets or inits the value of include type parameters
/// </summary>
public bool IncludeTypeParams { get; init; } = true;
Comment on lines +356 to +360
Copy link
Owner

@p1va p1va Oct 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do something similar to what has been done for the MethodDocumentationOptions class here and add the ParamsDocumentationOptions options directly on the ClassDocumentationOptions like

public class ClassDocumentationOptions : MemberDocumentationOptionsBase
{
    ...
    
    /// <summary>
    /// Gets or sets the value of the type parameters
    /// </summary>
    public ParamsDocumentationOptions TypeParameters { get; set; } = new();
    
    ...
}

}

/// <summary>
Expand Down
11 changes: 11 additions & 0 deletions src/DotnetDocument/Strategies/ClassDocumentationStrategy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,17 @@ public override ClassDeclarationSyntax Apply(ClassDeclarationSyntax node)
.For(node)
.WithSummary(summary);

// If type params has to be included
if (_options.Summary.IncludeTypeParams)
{
var typeParams = SyntaxUtils
.ExtractTypeParams(node.TypeParameterList)
.Select(x => (x, string.Empty))
.ToList();

builder.WithTypeParams(typeParams);
}
Comment on lines +73 to +82
Copy link
Owner

@p1va p1va Oct 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we go with the approach mentioned in the above comment this one could become

// If type params has to be included
if (_options.TypeParameters.Enabled)
{
    // Extract type params and generate a description
    var typeParams = SyntaxUtils
        .ExtractTypeParams(node.TypeParameterList)
        .Select(p => (p, _formatter
            .FormatName(_options.TypeParameters.Template, (TemplateKeys.Name, p))));

    builder.WithTypeParams(typeParams);
}


// If inheritance has to be included
if (_options.Summary.IncludeInheritance)
{
Expand Down