Skip to content

feat: add global functions to mdbook, allow documenting arguments and return values#296

Merged
makspll merged 4 commits into
mainfrom
feat/improve-mdbook-preprocessor
Feb 20, 2025
Merged

feat: add global functions to mdbook, allow documenting arguments and return values#296
makspll merged 4 commits into
mainfrom
feat/improve-mdbook-preprocessor

Conversation

@makspll

@makspll makspll commented Feb 19, 2025

Copy link
Copy Markdown
Owner

ladfile builder will now parse docstrings of the following kind:

/// Arguments:
/// * `arg_name1` : doc1
/// Returns:
/// * `return_name` : doc2

And attaches those to newly added documentation fields on the arguments of functions and return types.

Also refactors mdbook preprocessor slightly, to make use of these, as well as re-structures the generated markdown.

@makspll makspll changed the title feat: add global functions to mdbook preprocessor, allow documenting arguments and return values specifically feat: add global functions to mdbook preprocessor, allow documenting arguments and return values Feb 19, 2025
@makspll makspll changed the title feat: add global functions to mdbook preprocessor, allow documenting arguments and return values feat: add global functions to mdbook, allow documenting arguments and return values Feb 19, 2025
@makspll makspll enabled auto-merge (squash) February 19, 2025 23:50
@makspll makspll merged commit 630cac1 into main Feb 20, 2025
@makspll makspll deleted the feat/improve-mdbook-preprocessor branch February 20, 2025 00:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant