Skip to content

Rework documentation for Bucketladder #10

@xdisna2

Description

@xdisna2

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?

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions