Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework documentation for Bucketladder #10

Open
14 tasks
xdisna2 opened this issue Mar 22, 2022 · 2 comments
Open
14 tasks

Rework documentation for Bucketladder #10

xdisna2 opened this issue Mar 22, 2022 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@xdisna2
Copy link
Contributor

xdisna2 commented Mar 22, 2022

TODO for class documentation file:

  • List of public methods
  • List of private methods
  • Brainstorm possible Tele-Op/Autonomy variables
  • Write Description of public methods
  • Write Description of private methods

Requirements for method documentation:

  • Function Title
  • Use Case Description
  • Arguments
  • Return statement

Each method(s) will be hyperlinked!
Structure of MD

  • Title of Class
  • Purpose
  • List of Public Methods
  • List of Private Methods
  • XML diagram?
@xdisna2 xdisna2 self-assigned this Mar 22, 2022
@xdisna2 xdisna2 added the documentation Improvements or additions to documentation label Mar 22, 2022
@xdisna2 xdisna2 added this to the Arduino Documentation milestone Mar 22, 2022
@xdisna2
Copy link
Contributor Author

xdisna2 commented Mar 22, 2022

TODO for .md Subsystem Summary:

  • Basic Functionality
  • List of Hardware
  • List of Teensy Connections
  • Schematic
  • More Information Links

@xdisna2
Copy link
Contributor Author

xdisna2 commented Mar 22, 2022

Commenting structure for Header and Implementation:

  • Add in Header description for .h and .cpp (include Author name(s))
  • Minimal commenting of Header file (.h)
  • Short description of method and arguments

@xdisna2 xdisna2 added the good first issue Good for newcomers label Mar 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant