wpilibsuite/allwpilib

Add doxygen comments to hal/simulation objects

Open

#2,354 opened on Feb 11, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (714 forks)auto 404
component: halgood first issueos: simulationtype: docs

Repository metrics

Stars
 (1,281 stars)
PR merge metrics
 (PR metrics pending)

Description

Looking forward towards a future where users actually use these. :)

Contributor guide

Research direction
Find the hal/simulation source files in the repository and add Doxygen comments to the objects (classes, functions, etc.) following the existing comment style.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85