Skip to content

Auto-generate documentation for public classes from AST #101

Description

Context

PowerShell modules built with the PSModule framework can have public classes, but there is no automated way to generate documentation for them. Function documentation is auto-generated from comment-based help, but classes lack an equivalent process.

Request

The Build or Document step should auto-generate documentation files for public classes by analyzing the AST for comment-based documentation on properties and methods, then exporting them to markdown files.

Acceptance criteria

  • Public class files are parsed for documentation comments on properties and methods
  • Markdown documentation files are generated for each public class
  • The generated documentation is included in the documentation site
  • Classes without documentation comments produce a skeleton or warning

Technical decisions

To be determined during implementation planning — evaluate AST-based comment extraction and output format.


Implementation plan

  • Implement AST parsing for class files to extract property and method documentation
  • Generate markdown documentation from the extracted information
  • Output documentation files to the docs folder
  • Integrate generated class docs into the MkDocs navigation
  • Test with classes that have full, partial, and no documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions