Skip to main content

Module docs

stryke

Module docs 

Source
Expand description

Module-doc generator — produces Markdown documentation from a parsed stryke source file by pairing ## doc comments with the top-level declaration immediately below them.

Driven by the project-wide CLI subcommand stryke gen-docs [PATH] [--out DIR], which walks a directory tree and calls generate_markdown once per source file.

Functions§

generate_markdown
Emit Markdown for every top-level declaration in program that’s considered a public API surface (fn / struct / enum / class / trait / package / use constant). Doc comments are extracted from the SOURCE — consecutive ## lines immediately above the declaration line — so the parser/AST doesn’t need to track them.