Skip to content

Commit

Permalink
Fix JavaDoc 21 warning and clean up generated files
Browse files Browse the repository at this point in the history
JavaDoc 21 warns about missing docs for implicit constructors.

`<cstdint>` was replaced with `<stdint.h>` because the latter provides
the typedefs without the `std::` prefix. Using `<cstdint>` for it is UB.
  • Loading branch information
calcmogul committed Feb 23, 2025
1 parent 4d82133 commit 9501324
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 1 deletion.
4 changes: 4 additions & 0 deletions choreolib/src/main/java/choreo/util/TrajSchemaVersion.java
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
// Copyright (c) Choreo contributors

// Auto-generated by update_traj_schema.py

package choreo.util;

/** Internal autogenerated class for storing the current trajectory schema version. */
public class TrajSchemaVersion {
/** The current trajectory schema version. */
public static final int TRAJ_SCHEMA_VERSION = 1;

/** Utility class. */
private TrajSchemaVersion() {}
}
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
// Copyright (c) Choreo contributors

// Auto-generated by update_traj_schema.py

#pragma once

#include <stdint.h>

namespace choreo {

[[deprecated("Use kTrajSchemaVersion.")]]
inline constexpr uint32_t kTrajSpecVersion = 1;
inline constexpr uint32_t kTrajSchemaVersion = 1;

} // namespace choreo
Empty file modified update_field_dimensions.py
100644 → 100755
Empty file.
Empty file modified update_project_schema.py
100644 → 100755
Empty file.
11 changes: 10 additions & 1 deletion update_traj_schema.py
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,16 @@ class Location:
template=lambda version: f"""// Copyright (c) Choreo contributors
// Auto-generated by update_traj_schema.py
package choreo.util;
/** Internal autogenerated class for storing the current trajectory schema version. */
public class TrajSchemaVersion {{
/** The current trajectory schema version. */
public static final int TRAJ_SCHEMA_VERSION = {version};
/** Utility class. */
private TrajSchemaVersion() {{}}
}}""",
),
# Python ChoreoLib
Expand All @@ -61,12 +65,17 @@ class Location:
template=lambda version: f"""// Copyright (c) Choreo contributors
// Auto-generated by update_traj_schema.py
#pragma once
#include <cstdint>
#include <stdint.h>
namespace choreo {{
[[deprecated("Use kTrajSchemaVersion.")]]
inline constexpr uint32_t kTrajSpecVersion = {version};
inline constexpr uint32_t kTrajSchemaVersion = {version};
}} // namespace choreo""",
),
]
Expand Down

0 comments on commit 9501324

Please sign in to comment.