Skip to content

Added Automatic Documentation for SGP mode scripts - #325

Open
EliasH-E wants to merge 15 commits into
anyaevostinar:mainfrom
EliasH-E:SGP-docu
Open

Added Automatic Documentation for SGP mode scripts#325
EliasH-E wants to merge 15 commits into
anyaevostinar:mainfrom
EliasH-E:SGP-docu

Conversation

@EliasH-E

Copy link
Copy Markdown
Collaborator

API documentation now is also created with Doxygen for all SGP mode scripts
Added per function documentation for many function in SGP that were missing them.

@codecov

codecov Bot commented Jul 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.09%. Comparing base (80c2445) to head (1ab176d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #325   +/-   ##
=======================================
  Coverage   77.09%   77.09%           
=======================================
  Files         108      108           
  Lines       23155    23155           
  Branches     1615     1615           
=======================================
  Hits        17852    17852           
  Misses       5232     5232           
  Partials       71       71           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread source/sgp_mode/hardware/CPUState.h Outdated
Comment thread source/sgp_mode/hardware/SGPHardware.h Outdated
Comment thread source/sgp_mode/hardware/Stacks.h
Comment thread source/sgp_mode/tasks/TaskSet.h Outdated
Comment thread source/sgp_mode/ProgramBuilder.h
Comment thread source/sgp_mode/Scheduler.h
Comment thread source/sgp_mode/SGPHost.h Outdated
Comment thread source/sgp_mode/SGPMutator.h
Comment thread source/sgp_mode/SGPSymbiont.h Outdated
if (interact) {
break;
}

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

why?

Comment thread source/sgp_mode/SGPW_InteractionMechanismSetup.cc Outdated
Comment thread source/sgp_mode/SGPWorld.h Outdated

@anyaevostinar anyaevostinar left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Couple of fixes needed

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.

2 participants