Skip to content

Migrate ts client detailed design to doxygen - #201

Open
ryan-steel wants to merge 1 commit into
eclipse-score:mainfrom
etas-contrib:migrate-ts_client-detailed-design-to-doxygen
Open

Migrate ts client detailed design to doxygen#201
ryan-steel wants to merge 1 commit into
eclipse-score:mainfrom
etas-contrib:migrate-ts_client-detailed-design-to-doxygen

Conversation

@ryan-steel

@ryan-steel ryan-steel commented Aug 31, 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 of this is removal of unnecessary implementation reqs from the detailed design, and updating doxygen comments.

Related ticket

Part of #97

@ryan-steel
ryan-steel force-pushed the migrate-ts_client-detailed-design-to-doxygen branch from 7cb8ad5 to 315a28b Compare August 31, 2026 08:37
@github-actions

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: a26dd709-0ae9-4813-8044-eeff6a319afc
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: 
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 (72 packages loaded, 10 targets configured)

Analyzing: target //:license-check (109 packages loaded, 218 targets configured)

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

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

Analyzing: target //:license-check (169 packages loaded, 6308 targets configured)

Analyzing: target //:license-check (169 packages loaded, 6308 targets configured)

Analyzing: target //:license-check (169 packages loaded, 6308 targets configured)

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

Analyzing: target //:license-check (174 packages loaded, 11401 targets configured)

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

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

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

INFO: Analyzed target //:license-check (177 packages loaded, 11555 targets configured).
[12 / 16] checking cached actions
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[13 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox
[15 / 16] Building license.check.license_check.jar (); 0s disk-cache, multiplex-worker
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: 35.021s, Critical Path: 2.47s
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 marked this pull request as ready for review September 1, 2026 13:52
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