Skip to content

migrate time_daemon detailed design to doxygen - #194

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

migrate time_daemon detailed design to doxygen#194
ryan-steel wants to merge 2 commits into
eclipse-score:mainfrom
etas-contrib:migrate-time_daemon-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.

Most unit-level diagrams removed. From implementation guidelines:

A separate static diagram per unit is not required; the unit's attributes and behaviour are documented in the source code itself as the source code is sufficiently self-explanatory and adheres to the design principles outlined in the development plan.

This is sufficient for ASIL B compliance per :need:ISO 26262-6 §8 <std_req__iso26262__software_841>, as the structural decomposition is evident from the directory layout and the component-level static view of the architecture already captures the relevant unit relationships.

Related ticket

Part of #95

@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: 669d6daa-feeb-4976-bd73-ff3cb019056d
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 (75 packages loaded, 10 targets configured)

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

Analyzing: target //:license-check (146 packages loaded, 2300 targets configured)

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

Analyzing: target //:license-check (161 packages loaded, 7084 targets configured)

Analyzing: target //:license-check (171 packages loaded, 7395 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 (173 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (176 packages loaded, 11429 targets configured)

INFO: Analyzed target //:license-check (177 packages loaded, 11555 targets configured).
[9 / 16] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_tooling+/dash/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local
[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: 29.215s, Critical Path: 2.46s
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_daemon-detailed-design-to-doxygen branch from 70d4c8d to d045f49 Compare August 27, 2026 11:21
@ryan-steel
ryan-steel force-pushed the migrate-time_daemon-detailed-design-to-doxygen branch from d045f49 to 68d8922 Compare August 27, 2026 12:21
@ryan-steel
ryan-steel force-pushed the migrate-time_daemon-detailed-design-to-doxygen branch from 68d8922 to 69c49c5 Compare August 27, 2026 12:27
@ryan-steel
ryan-steel force-pushed the migrate-time_daemon-detailed-design-to-doxygen branch from 3f098ab to 756566c Compare August 28, 2026 11:08
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.

1 participant