[wpilib] Impove Mechanism2D documentation (NFC) (#3584)

This commit is contained in:
sciencewhiz
2021-09-17 22:54:10 -07:00
committed by GitHub
parent fe59e4b9fe
commit 4d5fca27ef
6 changed files with 27 additions and 8 deletions

View File

@@ -16,8 +16,12 @@ namespace frc {
/**
* Root Mechanism2d node.
*
* A root is the anchor point of other nodes (such as ligaments).
*
* Do not create objects of this class directly! Obtain pointers from the
* Mechanism2d.GetRoot() factory method.
*
* <p>Append other nodes by using Append().
*/
class MechanismRoot2d : private MechanismObject2d {
friend class Mechanism2d;