Summary.Roslyn 0.0.2

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Summary.Roslyn --version 0.0.2                

                    
                

            
NuGet\Install-Package Summary.Roslyn -Version 0.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Summary.Roslyn" Version="0.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Summary.Roslyn --version 0.0.2                

                    
                

            
#r "nuget: Summary.Roslyn, 0.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Summary.Roslyn as a Cake Addin
#addin nuget:?package=Summary.Roslyn&version=0.0.2

// Install Summary.Roslyn as a Cake Tool
#tool nuget:?package=Summary.Roslyn&version=0.0.2

<div align="center"> <img src="./res/icon-512.png" alt="Logo" width="128" height="128"></img> </div> <h1 align="center"><summary></h1>

<p align="center"> <i>Flexible and effortless API reference generator for .NET.</i> </p>

Usage

Currently, the generator is pretty young. In order to use it, you should download Summary (Core), Summary.Roslyn (Parser) and Summary.Markdown (Renderer) packages.

Here is a simple code-snippet that parses files in the specified directory:

// The folder you want to parse the `*.cs` files from.
const string input = "./src";

// The folder you want to put the generator output into.
const string output = "./docs";

await
    // Scan all `*.cs` files in the specified `input` path.
    new DirectoryScannerPipe(input, "*.cs")

    // Parse each file into Roslyn `SyntaxTree`.
    .ThenForAll(new SyntaxTreeParserPipe())

    // Parse each `SyntaxTree` into `Doc`.
    .ThenForAll(new DocumentParserPipe())

    // Merge multiple docs into single doc.
    .Then(new FlattenPipe<Doc>(Doc.Merge))

    // Remove non-public types and members.
    .Then(new PublicFilterPipe())

    // Render the `Doc` into series of Markdown files (one file for each type).
    .Then(new MarkdownRenderPipe())

    // Save each Markdown file into separate file.
    .ThenForAll(new SavePipe<Markdown>(output, x => (x.Name, x.Content)))

    // Execute the pipeline.
    .Run();
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.