Skip to content

migrate time_slave detailed design to doxygen - #193

Draft
ryan-steel wants to merge 3 commits into
eclipse-score:mainfrom
etas-contrib:migrate-time_slave-detailed-design-to-doxygen
Draft

migrate time_slave detailed design to doxygen#193
ryan-steel wants to merge 3 commits into
eclipse-score:mainfrom
etas-contrib:migrate-time_slave-detailed-design-to-doxygen

Conversation

@ryan-steel

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 #96

@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown

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: 89c8a12b-e2c3-4405-a683-cebe13df5fc0
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
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
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

Analyzing: target //:license-check (73 packages loaded, 10 targets configured)

Analyzing: target //:license-check (91 packages loaded, 10 targets configured)

Analyzing: target //:license-check (151 packages loaded, 1433 targets configured)

Analyzing: target //:license-check (160 packages loaded, 4509 targets configured)

Analyzing: target //:license-check (164 packages loaded, 9024 targets configured)

Analyzing: target //:license-check (164 packages loaded, 9358 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (175 packages loaded, 11305 targets configured)

Analyzing: target //:license-check (177 packages loaded, 11553 targets configured)

INFO: Analyzed target //:license-check (177 packages loaded, 11555 targets configured).
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions running)
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 31.686s, Critical Path: 2.79s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

2 participants