Skip to content

Fix #2223, correct Doxygen parameter names - #2780

Open
Sushanth012 wants to merge 1 commit into
nasa:devfrom
Sushanth012:fix-2223-doxygen-params
Open

Fix #2223, correct Doxygen parameter names#2780
Sushanth012 wants to merge 1 commit into
nasa:devfrom
Sushanth012:fix-2223-doxygen-params

Conversation

@Sushanth012

Copy link
Copy Markdown

Description of Change

Correct the Doxygen parameter documentation for UT_CallTaskPipe() and UT_DisplayPkt() so every documented name matches the corresponding function declaration. This removes stale names left behind by earlier signature changes and documents the four current UT_CallTaskPipe() parameters.

Linked Issue

Closes #2223

Areas of Expertise Touched

  • ASTRO
  • CI/CD
  • COSMOS
  • Cybersecurity
  • Docker
  • EDS
  • Git
  • PSPs
  • SBN
  • SMP
  • Tables
  • TSN
  • Unit Tests
  • Other

Author Checklist

  • Linked GitHub issue is referenced above/linked to this PR
  • Documentation generation workflow ran successfully on this branch
  • Changes are limited to documentation/comments (no code behavior changes)

Testing

  • git diff upstream/dev...HEAD --check
  • Confirmed each Doxygen param name exactly matches its function declaration

Reviewer Checklist

  • Documentation is clear, accurate, and complete
  • Spelling and grammar reviewed
  • Any links in the documentation have been verified to work
  • Documentation generation workflow output looks correct
  • Appropriate Expert areas have been reviewed

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.

Out-of-date Doxygen @param names

2 participants