Docs: Switch Flight Computer documentation to doxygen style

Open
#296 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
c
Domain
documentation

Research direction

Start by reviewing the existing comments under app/rev2 and init/ and identify the comment-style changes needed for Doxygen. The work is done when the documentation comments in both areas consistently use the project's Doxygen style.

Written by the indexing model from the issue text.

Description

documentation

Description
This subtask is intended to capture the effort required to switch the comment style for app/rev2 and init/ to Doxygen in the firmware.

Points of Contact
Project Lead: @NArmistead

Dominant language
C
Stars
8
Forks
6
Avg merge
6d 15h
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SunDevilRocketry/Flight-Computer-Firmware

All issues in SunDevilRocketry/Flight-Computer-Firmware

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.