mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-25 01:41:43 +00:00
[docs] Add missing JavaDocs (#6146)
This commit is contained in:
@@ -15,12 +15,20 @@
|
||||
|
||||
namespace wpi {
|
||||
|
||||
/**
|
||||
* Helper class for building Sendable dashboard representations.
|
||||
*/
|
||||
class SendableBuilder {
|
||||
public:
|
||||
/**
|
||||
* The backend kinds used for the sendable builder.
|
||||
*/
|
||||
enum BackendKind { kUnknown, kNetworkTables };
|
||||
enum BackendKind {
|
||||
/// Unknown.
|
||||
kUnknown,
|
||||
/// NetworkTables.
|
||||
kNetworkTables
|
||||
};
|
||||
|
||||
virtual ~SendableBuilder() = default;
|
||||
|
||||
|
||||
@@ -32,18 +32,31 @@ class StructDescriptorDatabase;
|
||||
* Known data types for raw struct dynamic fields (see StructFieldDescriptor).
|
||||
*/
|
||||
enum class StructFieldType {
|
||||
/// bool.
|
||||
kBool,
|
||||
/// char.
|
||||
kChar,
|
||||
/// int8.
|
||||
kInt8,
|
||||
/// int16.
|
||||
kInt16,
|
||||
/// int32.
|
||||
kInt32,
|
||||
/// int64.
|
||||
kInt64,
|
||||
/// uint8.
|
||||
kUint8,
|
||||
/// uint16.
|
||||
kUint16,
|
||||
/// uint32.
|
||||
kUint32,
|
||||
/// uint64.
|
||||
kUint64,
|
||||
/// float.
|
||||
kFloat,
|
||||
/// double.
|
||||
kDouble,
|
||||
/// struct.
|
||||
kStruct
|
||||
};
|
||||
|
||||
|
||||
@@ -17,18 +17,31 @@ namespace wpi::structparser {
|
||||
* A lexed raw struct schema token.
|
||||
*/
|
||||
struct Token {
|
||||
/** A lexed raw struct schema token kind. */
|
||||
enum Kind {
|
||||
/// Unknown.
|
||||
kUnknown,
|
||||
/// Integer.
|
||||
kInteger,
|
||||
/// Identifier.
|
||||
kIdentifier,
|
||||
/// Left square bracket.
|
||||
kLeftBracket,
|
||||
/// Right square bracket.
|
||||
kRightBracket,
|
||||
/// Left curly brace.
|
||||
kLeftBrace,
|
||||
/// Right curly brace.
|
||||
kRightBrace,
|
||||
/// Colon.
|
||||
kColon,
|
||||
/// Semicolon.
|
||||
kSemicolon,
|
||||
/// Comma.
|
||||
kComma,
|
||||
/// Equals.
|
||||
kEquals,
|
||||
/// End of input.
|
||||
kEndOfInput,
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user