Skip to content

docs(doxygen): add PR trigger and standardize Doxyfile#855

Merged
kcenon merged 2 commits into
mainfrom
docs/doxygen-pr-trigger-and-standardization
Mar 17, 2026
Merged

docs(doxygen): add PR trigger and standardize Doxyfile#855
kcenon merged 2 commits into
mainfrom
docs/doxygen-pr-trigger-and-standardization

Conversation

@kcenon

@kcenon kcenon commented Mar 17, 2026

Copy link
Copy Markdown
Owner

What

Summary

Add pull_request trigger to Doxygen workflow and standardize Doxyfile settings (PROJECT_NUMBER, CREATE_SUBDIRS).

Change Type

  • Documentation
  • Chore

Why

Related Issues

Motivation

network_system was the only library missing pull_request trigger in its Doxygen workflow. Without it, documentation-breaking changes from header modifications aren't caught until after merge to main.

Where

Files Changed

File Change
.github/workflows/build-Doxygen.yaml Add pull_request trigger
Doxyfile PROJECT_NUMBER + CREATE_SUBDIRS

How

Implementation Details

  1. PR trigger: Added pull_request: branches: [main] to workflow triggers
  2. PROJECT_NUMBER: Added 0.1.1 (synced with vcpkg.json)
  3. CREATE_SUBDIRS: NOYES (matching all other ecosystem libraries)

Test Plan

  1. This PR itself validates the PR trigger — Doxygen build should run
  2. After merge, push to main triggers build + deploy as before

kcenon added 2 commits March 17, 2026 18:43
…network_system::)

Adopt ecosystem convention of <name>:: snake_case namespace.
Existing backward compatibility aliases already cover NetworkSystem:: consumers.

Closes #852
Add pull_request trigger to Doxygen workflow so documentation-breaking
changes are caught before merge. All other ecosystem libraries already
include this trigger.

Standardize Doxyfile settings:
- PROJECT_NUMBER: add 0.1.1 (sync with vcpkg.json)
- CREATE_SUBDIRS: NO -> YES (match ecosystem standard)

Closes #854
@github-actions

Copy link
Copy Markdown
Contributor

Performance Comparison

Base Branch Results

No base results

PR Branch Results

No PR results

@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

Metric Value
Line Coverage 60.9%
Target 75% (stretch: 80%)
Coverage Details

Full HTML report is available as a build artifact.

@kcenon kcenon merged commit d1a6a00 into main Mar 17, 2026
42 checks passed
@kcenon kcenon deleted the docs/doxygen-pr-trigger-and-standardization branch March 17, 2026 23:34
kcenon added a commit that referenced this pull request Apr 13, 2026
* chore(cmake): standardize namespace to snake_case (NetworkSystem:: → network_system::)

Adopt ecosystem convention of <name>:: snake_case namespace.
Existing backward compatibility aliases already cover NetworkSystem:: consumers.

Closes #852

* docs(doxygen): add PR trigger and standardize Doxyfile

Add pull_request trigger to Doxygen workflow so documentation-breaking
changes are caught before merge. All other ecosystem libraries already
include this trigger.

Standardize Doxyfile settings:
- PROJECT_NUMBER: add 0.1.1 (sync with vcpkg.json)
- CREATE_SUBDIRS: NO -> YES (match ecosystem standard)

Closes #854
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.

docs(doxygen): Add pull_request trigger to Doxygen workflow

1 participant