Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-24 01:31:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Fix Doxygen warnings, add CI docs lint job (#3639)

Browse Source 
The CI docs lint build is configured to fail on Doxygen warnings.
This commit is contained in:
Tyler Veness
2021-10-14 18:09:38 -07:00
committed by GitHub
parent 4ad3a54026
commit 4647d09b50
125 changed files with 1723 additions and 1131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
wpimath/src/main/native/include/frc/trajectory/TrajectoryUtil.h
View File

@@ -21,8 +21,6 @@ class WPILIB_DLLEXPORT TrajectoryUtil {
*
* @param trajectory the trajectory to export
* @param path the path of the file to export to
*
* @return The interpolated state.
*/
static void ToPathweaverJson(const Trajectory& trajectory,
std::string_view path);
@@ -38,19 +36,19 @@ class WPILIB_DLLEXPORT TrajectoryUtil {
/**
* Deserializes a Trajectory from PathWeaver-style JSON.
*
* @param json the string containing the serialized JSON
* @param trajectory the trajectory to export
*
* @return the trajectory represented by the JSON
* @return the string containing the serialized JSON
*/
static std::string SerializeTrajectory(const Trajectory& trajectory);
/**
* Serializes a Trajectory to PathWeaver-style JSON.
*
* @param trajectory the trajectory to export
* @param jsonStr the string containing the serialized JSON
*
* @return the string containing the serialized JSON
* @return the trajectory represented by the JSON
*/
static Trajectory DeserializeTrajectory(std::string_view json_str);
static Trajectory DeserializeTrajectory(std::string_view jsonStr);
};
} // namespace frc