[docs] Build with JavaDoc 17 and add missing docs (#6220)

Co-authored-by: Sam Carlberg <sam.carlberg@gmail.com>
This commit is contained in:
Tyler Veness
2024-01-19 23:42:09 -08:00
committed by GitHub
parent 9ec27c1202
commit 77c09b9ce2
54 changed files with 3527 additions and 26 deletions

View File

@@ -40,5 +40,6 @@ public abstract class EntryBase implements Subscriber, Publisher {
return NetworkTablesJNI.getEntryLastChange(m_handle);
}
/** NetworkTables handle. */
protected int m_handle;
}

View File

@@ -7,16 +7,31 @@ package edu.wpi.first.networktables;
/** NetworkTables log message. */
@SuppressWarnings("MemberName")
public final class LogMessage {
/** Logging levels. */
/** Critical logging level. */
public static final int kCritical = 50;
/** Error logging level. */
public static final int kError = 40;
/** Warning log level. */
public static final int kWarning = 30;
/** Info log level. */
public static final int kInfo = 20;
/** Debug log level. */
public static final int kDebug = 10;
/** Debug log level 1. */
public static final int kDebug1 = 9;
/** Debug log level 2. */
public static final int kDebug2 = 8;
/** Debug log level 3. */
public static final int kDebug3 = 7;
/** Debug log level 4. */
public static final int kDebug4 = 6;
/** Log level of the message. */

View File

@@ -6,6 +6,7 @@ package edu.wpi.first.networktables;
import edu.wpi.first.util.sendable.SendableBuilder;
/** Helper class for building Sendable dashboard representations for NetworkTables. */
public interface NTSendableBuilder extends SendableBuilder {
/**
* Set the function that should be called to update the network table for things other than

View File

@@ -12,6 +12,7 @@ package edu.wpi.first.networktables;
*/
@SuppressWarnings("MemberName")
public final class NetworkTableEvent {
/** NetworkTable event kind. */
public enum Kind {
/**
* Initial listener addition. Set this to receive immediate notification of matches to other
@@ -61,6 +62,11 @@ public final class NetworkTableEvent {
this.value = value;
}
/**
* Returns the NetworkTable event kind value.
*
* @return The NetworkTable event kind value.
*/
public int getValue() {
return value;
}

View File

@@ -39,10 +39,20 @@ public enum NetworkTableType {
m_valueStr = valueStr;
}
/**
* Returns the NetworkTable type value.
*
* @return The NetworkTable type value.
*/
public int getValue() {
return m_value;
}
/**
* Returns the NetworkTable type value as as string.
*
* @return The NetworkTable type value as a string.
*/
public String getValueStr() {
return m_valueStr;
}

View File

@@ -153,6 +153,11 @@ public final class ProtobufTopic<T> extends Topic {
false);
}
/**
* Returns the protobuf.
*
* @return The protobuf.
*/
public Protobuf<T, ?> getProto() {
return m_proto;
}

View File

@@ -153,6 +153,11 @@ public final class StructArrayTopic<T> extends Topic {
false);
}
/**
* Returns the struct.
*
* @return The struct.
*/
public Struct<T> getStruct() {
return m_struct;
}

View File

@@ -152,6 +152,11 @@ public final class StructTopic<T> extends Topic {
false);
}
/**
* Returns the struct.
*
* @return The struct.
*/
public Struct<T> getStruct() {
return m_struct;
}

View File

@@ -336,6 +336,9 @@ public class Topic {
return m_handle;
}
/** NetworkTables instance. */
protected NetworkTableInstance m_inst;
/** NetworkTables handle. */
protected int m_handle;
}

View File

@@ -15,6 +15,10 @@
namespace nt {
/**
* Helper class for building Sendable dashboard representations for
* NetworkTables.
*/
class NTSendableBuilder : public wpi::SendableBuilder {
public:
/**

View File

@@ -396,6 +396,7 @@ class Publisher {
Publisher() = default;
explicit Publisher(NT_Publisher handle) : m_pubHandle{handle} {}
/// NetworkTables handle.
NT_Publisher m_pubHandle{0};
};