PH.Modeler 0.0.1

PH.Modeler

PH.Modeler is a library designed to document flows and steps in your C# code. It uses attributes to define flows and steps, making it easier to generate documentation automatically.

Installation

To install the package, use the following command:

dotnet add package PH.Modeler

How It Works

PH.Modeler uses two main attributes:

1. FlowAttribute: Used to define a flow in your application.
2. StepAttribute: Used to define a step within a flow.

FlowAttribute

The FlowAttribute is applied to classes or interfaces to define a flow. It includes properties like:

• Name: The name of the flow.
• Order: The order of the flow.
• Description: A description of the flow.
• PreviousFlowsNeeded: An array of flows that must be completed before this flow.

StepAttribute

The StepAttribute is applied to methods to define a step within a flow. It includes properties like:

• Flow: The name of the flow this step belongs to.
• Name: The name of the step.
• Order: The order of the step within the flow.
• Description: A description of the step.

Examples

Example 1: Documenting a Flow and Steps in IAutService

The IAutService interface defines a flow named "Auth Flow" with a step for logging in.

using PH.Modeler;

[Flow("Auth Flow")]
public interface IAutService
{
    [Step("Auth Flow", "do login", 1, "perform a new login")]
    Task<Response1> Login(Request1 request, CancellationToken token);
}

Example 2: Documenting a Flow and Steps in IDoSomeService

The IDoSomeService interface defines a flow named "Do Something Flow" with multiple steps.

using PH.Modeler;

[Flow("Do Something Flow", 2, "This Description is used to describe the flow.", PreviousFlowsNeeded = new[] { "Auth Flow" })]
public interface IDoSomeService
{
    [Step("Do Something Flow", "do something", 1, "perform something")]
    Task<DoSomeResponse> DoSomething(DoSomeRequest request, CancellationToken token);

    [Step("Do Something Flow", "Terminate flow", 3, "perform something else")]
    Task<(Response2 R, Response2 Second)> DoSomethingElse(DoSomeElseRequest request, CancellationToken token);
}

Example 3: Documenting a Flow and Steps in AnotherService

The AnotherService class defines a flow named "Do Something Flow Last" with a step for additional processing.

using PH.Modeler;

[Flow("Do Something Flow Last", PreviousFlowsNeeded = new[] { "Auth Flow", "Do Something Flow" })]
public class AnotherService : IAnotherService
{
    [Step("Do Something Flow Last", "Second Task", 2, "This is a description")]
    public Task<Response1> DoSomethingMore(Request1 request, CancellationToken token)
    {
        return Task.FromResult(new Response1 { SomeElse = "Done" });
    }
}

Generating Documentation

To generate documentation in Markdown format, use the DocumentationBuilder class:

using PH.Modeler;

var markdown = DocumentationBuilder.GetMarkdown(typeof(IAutService).Assembly);
Console.WriteLine(markdown);