arduino/Generate and Commit Docs
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| source-path | Source path containing the .h files | yes | — |
| target-path | Target path or file for the markdown documentation | yes | — |
| exclude-pattern | Pattern for excluding files (e.g. "*/test/*") | — | — |
| include-cpp | Include .cpp files | — | false |
| access-level | The minimum access level to be considered in the documentation | — | public |
| show-access-modifiers | Show access modifiers in the documentation | — | false |
| fail-on-warnings | Fail when documentation warnings are issued. | — | false |
| commit | Boolean flag to indicate whether to commit changes | — | true |
| commit-message | Commit message | — | Update documentation |
| committer-name | Username to use as author of the commit. | — | github-actions[bot] |
| committer-email | Email address to use as author of the commit. | — | 41898282+github-actions[bot]@users.noreply.github.com |
| debug | Enable debugging mode to provide additional output | — | false |
Outputs
no outputs