-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
113 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,14 @@ | ||
### C++ API | ||
|
||
[AdaptivePurePursuitController](@ref rz::AdaptivePurePursuitController) | ||
|
||
[test](@ref md_docs_tutorials_setup_setup) | ||
|
||
[rz Namespace](@ref rz) | ||
|
||
[okapi::literal Namespace](@ref okapi::literals) | ||
# C++ API | ||
|
||
View all the APIs here: | ||
- [Chassis API](@ref md_docs_api_chassis) | ||
- [Control API](@ref md_docs_api_control) | ||
- [Filter API](@ref md_docs_api_filter) | ||
- [Geometry API](@ref md_docs_api_geometry) | ||
- [Pathing API](@ref md_docs_api_pathing) | ||
- [Trajectory API](@ref md_docs_api_trajectory) | ||
- [Units API](@ref md_docs_api_units) | ||
- [Utility API](@ref md_docs_api_utility) | ||
|
||
View the full namespace here: | ||
- [rz Namespace](@ref rz) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Chassis API | ||
|
||
This API includes all the motion control algorithms that can be used for your robot's chassis in autonomous mode. They are all async, meaning they can be run concurrently with other parts of your robot. Make sure to not have two motion controllers control the chassis at the same time. | ||
- [AdaptivePurePursuitController](@ref rz::AdaptivePurePursuitController) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Control API | ||
explanation | ||
<br> | ||
<br> | ||
|
||
### Iterative Control API | ||
explanation | ||
- [IterativeVelBangBangController](@ref rz::IterativeVelBangBangController) | ||
- [IterativeVelTBHController](@ref rz::IterativeVelTBHController) | ||
|
||
### Async Control API | ||
explanation | ||
- [AsyncVelBangBangController](@ref rz::AsyncVelBangBangController) | ||
- [AsyncVelTBHController](@ref rz::AsyncVelTBHController) | ||
|
||
### Feedforward Control API | ||
explanation | ||
- [FeedforwardController](@ref rz::FeedforwardController) | ||
- [SimpleMotorFeedforward](@ref rz::SimpleMotorFeedforward) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Filter API | ||
|
||
explanation here | ||
- [SlewRate](@ref rz::SlewRate) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Geometry API | ||
explanation | ||
<br> | ||
<br> | ||
|
||
### Positioning API | ||
explanation | ||
- [Rotation](@ref rz::Rotation) | ||
- [Translation](@ref rz::Translation) | ||
- [Pose](@ref rz::Pose) | ||
- [Transform](@ref rz::Transform) | ||
- [Twist](@ref rz::Twist) | ||
|
||
### Coordinate System API | ||
explanation | ||
- [CoordinateAxis](@ref rz::CoordinateAxis) | ||
- [CoordinateRotation](@ref rz::CoordinateRotation) | ||
- [CoordinateSystem](@ref rz::CoordinateSystem) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Pathing API | ||
explanation | ||
- [DiscretePath](@ref rz::DiscretePath) | ||
- [ParametricPath](@ref rz::ParametricPath) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Trajectory API | ||
explanation | ||
<br> | ||
<br> | ||
|
||
### Trajectory API | ||
explanation | ||
- Nonexistent Trajectory Class | ||
|
||
### Motion Profile API | ||
explanation | ||
- [MotionProfile](@ref rz::MotionProfile) | ||
- [TrapezoidalMotionProfile](@ref rz::TrapezoidalMotionProfile) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Units API | ||
explanation (link to tutorial) | ||
|
||
- [Units](@ref okapi) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Utility API | ||
explanation | ||
<br> | ||
<br> | ||
|
||
### Multithreading API | ||
explanation | ||
- [CrossPlatformThread](@ref rz::CrossPlatformThread) | ||
- [CrossPlatformMutex](@ref rz::CrossPlatformMutex) | ||
|
||
### Misc API | ||
explanation | ||
- [Math](@ref rz) | ||
- [Utility](@ref rz) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,29 @@ | ||
DOXYFILE = 'Doxyfile-mcss' | ||
|
||
FAVICON = '../images/raid_zero.png' | ||
|
||
LINKS_NAVBAR1 = [ | ||
('Get started', 'md_docs_tutorials_setup_setup', []), | ||
('Get Started', 'md_docs_tutorials_setup_setup', []), | ||
('Examples', 'md_docs_tutorials_examples_examples', []) | ||
] | ||
|
||
LINKS_NAVBAR2 = [ | ||
('Classes', 'annotated', []), | ||
('C++ API', 'md_docs_api_api', [ | ||
('Pages', 'pages'), | ||
('Setup Guide', 'md_docs_tutorials_setup_setup'), | ||
('Namespace', 'namespaceokapi'), | ||
('Chassis API', 'md_docs_api_chassis'), | ||
('Control API', 'md_docs_api_control'), | ||
('Filter API', 'md_docs_api_filter'), | ||
('Geometry API', 'md_docs_api_geometry'), | ||
('Pathing API', 'md_docs_api_pathing'), | ||
('Trajectory API', 'md_docs_api_trajectory'), | ||
('Units API', 'md_docs_api_units'), | ||
('Utility API', 'md_docs_api_utility'), | ||
('Namespace', 'namespacerz') | ||
]) | ||
] | ||
|
||
STYLESHEETS = [ | ||
'./m.css/css/m-dark+documentation.compiled.css', | ||
'https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600' | ||
'https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600', | ||
'docs.css' | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
main p { | ||
text-indent: 0rem; | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.