Skip to content

Comments

[CI] Introduce CI job where we check if documentation for public members exist#448

Merged
Yaraslaut merged 2 commits intomasterfrom
ci/documentation_check
Feb 17, 2026
Merged

[CI] Introduce CI job where we check if documentation for public members exist#448
Yaraslaut merged 2 commits intomasterfrom
ci/documentation_check

Conversation

@Yaraslaut
Copy link
Member

No description provided.

@Yaraslaut Yaraslaut requested a review from a team as a code owner February 16, 2026 17:52
@github-actions github-actions bot added documentation Improvements or additions to documentation CI pipeline labels Feb 16, 2026
@Yaraslaut Yaraslaut force-pushed the ci/documentation_check branch 2 times, most recently from 4e2f4a8 to 691caad Compare February 16, 2026 20:47
@github-actions github-actions bot added Data Mapper Query Builder Data Binder SQL Data Binder support Core API Query Formatter SQL dialect implementations labels Feb 16, 2026
@Yaraslaut Yaraslaut force-pushed the ci/documentation_check branch from 691caad to 45cb6a3 Compare February 17, 2026 18:47
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_ERROR option
  • 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.

@Yaraslaut Yaraslaut force-pushed the ci/documentation_check branch from 45cb6a3 to 4f63397 Compare February 17, 2026 18:57
@Yaraslaut Yaraslaut force-pushed the ci/documentation_check branch from 4f63397 to 4ac179b Compare February 17, 2026 19:19
@github-actions github-actions bot added the tests label Feb 17, 2026
@Yaraslaut Yaraslaut merged commit 9a99be0 into master Feb 17, 2026
20 checks passed
@Yaraslaut Yaraslaut deleted the ci/documentation_check branch February 17, 2026 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI pipeline Core API Data Binder SQL Data Binder support Data Mapper documentation Improvements or additions to documentation Query Builder Query Formatter SQL dialect implementations tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant