CMakePP / CMinx

Generates API documentation for CMake functions and macros
https://cmakepp.github.io/CMinx/
Apache License 2.0
14 stars 5 forks source link

139 add documentation generation for option #144

Closed AutonomicPerfectionist closed 1 year ago

AutonomicPerfectionist commented 1 year ago

Is this pull request associated with an issue(s)? Fixes #139

Description This PR adds support for documenting CMAke option() commands. It also adds a new configuration option for documenting undocumented options.

TODOs

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.06 :tada:

Comparison is base (e51acd0) 97.09% compared to head (a4f4e16) 97.16%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #144 +/- ## ========================================== + Coverage 97.09% 97.16% +0.06% ========================================== Files 8 8 Lines 930 952 +22 ========================================== + Hits 903 925 +22 Misses 27 27 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `97.16% <100.00%> (+0.06%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/CMakePP/CMinx/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP) | Coverage Δ | | |---|---|---| | [src/cminx/aggregator.py](https://codecov.io/gh/CMakePP/CMinx/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#diff-c3JjL2NtaW54L2FnZ3JlZ2F0b3IucHk=) | `95.40% <100.00%> (+0.15%)` | :arrow_up: | | [src/cminx/config.py](https://codecov.io/gh/CMakePP/CMinx/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#diff-c3JjL2NtaW54L2NvbmZpZy5weQ==) | `100.00% <100.00%> (ø)` | | | [src/cminx/documentation\_types.py](https://codecov.io/gh/CMakePP/CMinx/pull/144?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#diff-c3JjL2NtaW54L2RvY3VtZW50YXRpb25fdHlwZXMucHk=) | `98.89% <100.00%> (+0.07%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

ryanmrichard commented 1 year ago

🚀 [bumpr] Bumped! New version:v1.1.8 Changes:v1.1.7...v1.1.8