Skip to content

Add API Documentation to Cookbook #726

@swharden

Description

@swharden

It would be nice if XML documentation for the public API were generated automatically and displayed on the ScottPlot website as part of the version-specific cookbooks.

@bclehmann previously suggested using DocFX (a static site generator) to generate these pages (#617). This is pretty close to ideal, but I'd like to more tightly control which classes/methods are documented, and have more control over how to break some modules apart into multiple pages (e.g., the "AddSomething" methods in the Plot module should have their own page). I don't have it all figured out yet, but this is what I'm thinking I'll do:

Exploratory PR #727

  • Generate XML documentation on every build

  • Tests should confirm all public methods are documented

  • Tests will generate API markdown tracked by git

  • Tests will generate API cookbook HTML pages

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions