Skip to content

migrate time_slave detailed design to doxygen - #193

Merged
NEOatNHNG merged 17 commits into
eclipse-score:mainfrom
etas-contrib:migrate-time_slave-detailed-design-to-doxygen
Oct 8, 2026
Merged

NEOatNHNG merged 17 commits into
eclipse-score:mainfrom
etas-contrib:migrate-time_slave-detailed-design-to-doxygen

Conversation

@ryan-steel

@ryan-steel ryan-steel commented Aug 27, 2026 •

Copy link
Copy Markdown
Contributor

Description

Migrates the detailed design docs to doxygen to match process description guidelines which state that detailed design documentation belongs in code rather than separate design artifacts.

Related ticket

Part of #88

@github-actions

github-actions Bot commented Aug 27, 2026 •

Copy link
Copy Markdown
Contributor

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 6e0a6355-d8e9-4ee8-b5a2-69f705ca29ad
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'platforms', the root module requires module version platforms@1.0.0, but got platforms@1.1.0 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'score_platform', the root module requires module version score_platform@0.7.1, but got score_platform@0.7.2 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'rules_oci', the root module requires module version rules_oci@2.2.7, but got rules_oci@2.3.0 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 3 packages loaded
WARNING: Target pattern parsing failed.
ERROR: Skipping '//:license-check': no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/time/time/BUILD
ERROR: no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/time/time/BUILD
INFO: Elapsed time: 14.711s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@ryan-steel
ryan-steel force-pushed the migrate-time_slave-detailed-design-to-doxygen branch from 7ee20a5 to 055bd61 Compare August 27, 2026 11:17
@ryan-steel
ryan-steel force-pushed the migrate-time_slave-detailed-design-to-doxygen branch from 055bd61 to e4959db Compare August 27, 2026 12:26
Comment thread score/time_slave/docs/detailed_design/index.rst
Comment thread score/time_slave/src/gptp/details/pdelay_measurer.h Outdated
Comment thread score/time_slave/src/gptp/details/pdelay_measurer.h
Comment thread score/time_slave/src/gptp/details/clock_util.h
@ryan-steel
ryan-steel force-pushed the migrate-time_slave-detailed-design-to-doxygen branch from e4959db to 46ec7c1 Compare August 27, 2026 15:22
@ryan-steel
ryan-steel marked this pull request as ready for review September 1, 2026 13:52

@BjoernAtBosch BjoernAtBosch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

Comment thread score/time_slave/src/gptp/gptp_engine.h Outdated
Comment thread score/time_slave/src/gptp/phc/phc_adjuster.h Outdated

@BjoernAtBosch BjoernAtBosch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Still LGTM

@NEOatNHNG NEOatNHNG left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Content reviewed by team.

@NEOatNHNG
NEOatNHNG merged commit 57b6ba9 into eclipse-score:main Oct 8, 2026
20 of 22 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in TIM - Time FT Oct 8, 2026
@NEOatNHNG
NEOatNHNG deleted the migrate-time_slave-detailed-design-to-doxygen branch October 8, 2026 09:50

This branch is waiting to be deployed

1 waiting deployment
workflow-approval — 48ab7745 Waiting Oct 7, 2026 by NEOatNHNG via qnx-build (arm64-qnx) / approval #889
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants