[CI] Introduce CI job where we check if documentation for public members exist#448
Merged
[CI] Introduce CI job where we check if documentation for public members exist#448
Conversation
4e2f4a8 to
691caad
Compare
691caad to
45cb6a3
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request introduces a new CI job to enforce documentation coverage for public members by enabling Doxygen's "warn as error" mode. The PR adds comprehensive documentation comments to public APIs across the codebase to ensure compliance with this new CI check.
Changes:
- Added GitHub Actions workflow job to check documentation coverage using Doxygen with warnings treated as errors
- Updated CMake configuration to support the new
LIGHTWEIGHT_DOCS_WARN_AS_ERRORoption - Added missing documentation comments to hundreds of public members across the codebase, including constructors, operators, methods, and fields
- Fixed documentation references in markdown files to use fully-qualified namespace paths
Reviewed changes
Copilot reviewed 48 out of 48 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/build.yml |
Added new check_docs CI job to verify documentation coverage |
docs/CMakeLists.txt |
Added LIGHTWEIGHT_DOCS_WARN_AS_ERROR option and excluded test/tool directories from docs |
docs/sql-migrations.md |
Fixed documentation references to use fully-qualified namespace paths |
docs/dbtool.md |
Fixed documentation reference to use fully-qualified namespace path |
src/Lightweight/SqlTransaction.hpp |
Added documentation for constructors and operators |
src/Lightweight/SqlStatement.hpp |
Added documentation for methods and operators |
src/Lightweight/SqlScopedTraceLogger.hpp |
Added documentation for constructors |
src/Lightweight/SqlSchema.hpp |
Added documentation for struct members and EventHandler methods |
src/Lightweight/SqlRealName.hpp |
Added documentation for methods, operators, and members |
src/Lightweight/SqlQueryFormatter.hpp |
Added documentation for methods and members |
src/Lightweight/SqlQuery/*.hpp |
Added documentation for query builder methods and members |
src/Lightweight/SqlMigration.hpp |
Added documentation for members and fixed unused parameter warnings |
src/Lightweight/SqlLogger.hpp |
Added documentation for constructors, operators, and members |
src/Lightweight/SqlError.hpp |
Added documentation for struct members |
src/Lightweight/SqlConnection.hpp |
Added documentation for constructors and operators |
src/Lightweight/SqlConnectInfo.hpp |
Added documentation for members and methods |
src/Lightweight/SqlBackup/*.hpp |
Added documentation for members, methods, and operators |
src/Lightweight/DataMapper/*.hpp |
Added documentation for methods, operators, and members |
src/Lightweight/DataBinder/*.hpp |
Added comprehensive documentation for data types, methods, and operators |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
45cb6a3 to
4f63397
Compare
4f63397 to
4ac179b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.