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

Co-authored-by: Sam Carlberg <sam.carlberg@gmail.com>

ntcore/src/generate/main/java/GenericPublisher.java.jinja

@@ -236,6 +236,12 @@ public interface GenericPublisher extends Publisher, Consumer<NetworkTableValue>
   boolean setDefault{{ t.TypeName }}({{ t.java.ValueType }} defaultValue);
 {% endif -%}
 {% if t.java.WrapValueType %}
+  /**
+   * Sets the entry's value if it does not exist.
+   *
+   * @param defaultValue the default value to set
+   * @return False if the entry exists with a different type
+   */
   boolean setDefault{{ t.TypeName }}({{ t.java.WrapValueType }} defaultValue);
 {% endif -%}
 {% endfor %}

ntcore/src/generate/main/java/NetworkTableInstance.java.jinja

@@ -68,6 +68,11 @@ public final class NetworkTableInstance implements AutoCloseable {
       this.value = value;
     }
 
+    /**
+     * Returns the network mode value.
+     *
+     * @return The network mode value.
+     */
     public int getValue() {
       return value;
     }

ntcore/src/generate/main/java/NetworkTablesJNI.java.jinja

@@ -14,6 +14,7 @@ import java.util.EnumSet;
 import java.util.OptionalLong;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+/** NetworkTables JNI. */
 public final class NetworkTablesJNI {
   static boolean libraryLoaded = false;
   static RuntimeLoader<NetworkTablesJNI> loader = null;
@@ -82,139 +83,494 @@ public final class NetworkTablesJNI {
     return new PubSubOptions(options);
   }
 
+  /**
+   * Returns default instance handle.
+   *
+   * @return Default instance handle.
+   */
   public static native int getDefaultInstance();
 
+  /**
+   * Creates an NT instance.
+   *
+   * @return NT instance handle.
+   */
   public static native int createInstance();
 
+  /**
+   * Destroys an NT instance.
+   *
+   * @param inst NT instance handle.
+   */
   public static native void destroyInstance(int inst);
 
+  /**
+   * Returns NT instance from handle.
+   *
+   * @param handle NT instance handle.
+   * @return NT instance.
+   */
   public static native int getInstanceFromHandle(int handle);
 
   private static native int getEntryImpl(
       int topic, int type, String typeStr, PubSubOptions options);
 
+  /**
+   * Returns NT entry handle.
+   *
+   * @param inst NT instance handle.
+   * @param key NT entry key.
+   * @return NT entry handle.
+   */
   public static native int getEntry(int inst, String key);
 
+  /**
+   * Returns NT entry handle.
+   *
+   * @param topic NT entry topic.
+   * @param type NT entry type.
+   * @param typeStr NT entry type as a string.
+   * @param options NT entry pubsub options.
+   * @return NT entry handle.
+   */
   public static int getEntry(
       int topic, int type, String typeStr, PubSubOptions options) {
     return getEntryImpl(topic, type, typeStr, options);
   }
 
+  /**
+   * Returns NT entry handle.
+   *
+   * @param topic NT entry topic.
+   * @param type NT entry type.
+   * @param typeStr NT entry type as a string.
+   * @param options NT entry pubsub options.
+   * @return NT entry handle.
+   */
   public static int getEntry(
       int topic, int type, String typeStr, PubSubOption... options) {
     return getEntryImpl(topic, type, typeStr, buildOptions(options));
   }
 
+  /**
+   * Returns NT entry name.
+   *
+   * @param entry NT entry handle.
+   * @return NT entry name.
+   */
   public static native String getEntryName(int entry);
 
+  /**
+   * Returns NT entry last change time in microseconds.
+   *
+   * @param entry NT entry handle.
+   * @return NT entry last change time in microseconds.
+   */
   public static native long getEntryLastChange(int entry);
 
+  /**
+   * Returns NT entry type.
+   *
+   * @param entry NT entry handle.
+   * @return NT entry type.
+   */
   public static native int getType(int entry);
 
   /* Topic functions */
 
+  /**
+   * Returns list of topic handles.
+   *
+   * @param inst NT instance handle.
+   * @param prefix Topic prefix.
+   * @param types Topic types.
+   * @return List of topic handles.
+   */
   public static native int[] getTopics(int inst, String prefix, int types);
 
+  /**
+   * Returns list of topic handles.
+   *
+   * @param inst NT instance handle.
+   * @param prefix Topic prefix.
+   * @param types Topic types as strings.
+   * @return List of topic handles.
+   */
   public static native int[] getTopicsStr(int inst, String prefix, String[] types);
 
+  /**
+   * Returns list of topic infos.
+   *
+   * @param instObject NT instance.
+   * @param inst NT instance handle.
+   * @param prefix Topic prefix.
+   * @param types Topic types.
+   * @return List of topic infos.
+   */
   public static native TopicInfo[] getTopicInfos(
       NetworkTableInstance instObject, int inst, String prefix, int types);
 
+  /**
+   * Returns list of topic infos.
+   *
+   * @param instObject NT instance.
+   * @param inst NT instance handle.
+   * @param prefix Topic prefix.
+   * @param types Topic types as strings.
+   * @return List of topic infos.
+   */
   public static native TopicInfo[] getTopicInfosStr(
       NetworkTableInstance instObject, int inst, String prefix, String[] types);
 
+  /**
+   * Returns Topic handle.
+   *
+   * @param inst NT instance handle.
+   * @param name Topic name.
+   * @return Topic handle.
+   */
   public static native int getTopic(int inst, String name);
 
+  /**
+   * Returns topic name.
+   *
+   * @param topic Topic handle.
+   * @return Topic name.
+   */
   public static native String getTopicName(int topic);
 
+  /**
+   * Returns topic type.
+   *
+   * @param topic Topic handle.
+   * @return Topic type.
+   */
   public static native int getTopicType(int topic);
 
+  /**
+   * Sets topic persistency.
+   *
+   * @param topic Topic handle.
+   * @param value True if topic should be persistent.
+   */
   public static native void setTopicPersistent(int topic, boolean value);
 
+  /**
+   * Returns true if topic is persistent.
+   *
+   * @param topic Topic handle.
+   * @return True if topic is persistent.
+   */
   public static native boolean getTopicPersistent(int topic);
 
+  /**
+   * Sets whether topic is retained.
+   *
+   * @param topic Topic handle.
+   * @param value True if topic should be retained.
+   */
   public static native void setTopicRetained(int topic, boolean value);
 
+  /**
+   * Returns true if topic is retained.
+   *
+   * @param topic Topic handle.
+   * @return True if topic is retained.
+   */
   public static native boolean getTopicRetained(int topic);
 
+  /**
+   * Sets topic caching.
+   *
+   * @param topic Topic handle.
+   * @param value True if topic should be cached.
+   */
   public static native void setTopicCached(int topic, boolean value);
 
+  /**
+   * Returns true if topic is cached.
+   *
+   * @param topic Topic handle.
+   * @return True if topic is cached.
+   */
   public static native boolean getTopicCached(int topic);
 
+  /**
+   * Returns topic type as string.
+   *
+   * @param topic Topic handle.
+   * @return Topic type as string.
+   */
   public static native String getTopicTypeString(int topic);
 
+  /**
+   * Returns true if topic exists.
+   *
+   * @param topic Topic handle.
+   * @return True if topic exists.
+   */
   public static native boolean getTopicExists(int topic);
 
+  /**
+   * Returns topic property.
+   *
+   * @param topic Topic handle.
+   * @param name Property name.
+   * @return Topic property.
+   */
   public static native String getTopicProperty(int topic, String name);
 
+  /**
+   * Sets topic property.
+   *
+   * @param topic Topic handle.
+   * @param name Property name.
+   * @param value Property value.
+   */
   public static native void setTopicProperty(int topic, String name, String value);
 
+  /**
+   * Deletes topic property.
+   *
+   * @param topic Topic handle.
+   * @param name Property name.
+   */
   public static native void deleteTopicProperty(int topic, String name);
 
+  /**
+   * Returns topic properties.
+   *
+   * @param topic Topic handle.
+   * @return Topic properties.
+   */
   public static native String getTopicProperties(int topic);
 
+  /**
+   * Sets topic properties.
+   *
+   * @param topic Topic handle.
+   * @param properties Topic properties.
+   */
   public static native void setTopicProperties(int topic, String properties);
 
+  /**
+   * Subscribes to topic.
+   *
+   * @param topic Topic handle.
+   * @param type Topic type.
+   * @param typeStr Topic type as a string.
+   * @param options Pubsub options.
+   * @return Subscriber handle.
+   */
   public static native int subscribe(
       int topic, int type, String typeStr, PubSubOptions options);
 
+  /**
+   * Subscribes to topic.
+   *
+   * @param topic Topic handle.
+   * @param type Topic type.
+   * @param typeStr Topic type as a string.
+   * @param options Pubsub options.
+   * @return Subscriber handle.
+   */
   public static int subscribe(
       int topic, int type, String typeStr, PubSubOption... options) {
     return subscribe(topic, type, typeStr, buildOptions(options));
   }
 
+  /**
+   * Unsubscribes from topic.
+   *
+   * @param sub Subscriber handle.
+   */
   public static native void unsubscribe(int sub);
 
+  /**
+   * Publishes topic.
+   *
+   * @param topic Topic handle.
+   * @param type Topic type.
+   * @param typeStr Topic type as a string.
+   * @param options Pubsub options.
+   * @return Publish handle.
+   */
   public static native int publish(
       int topic, int type, String typeStr, PubSubOptions options);
 
+  /**
+   * Publishes topic.
+   *
+   * @param topic Topic handle.
+   * @param type Topic type.
+   * @param typeStr Topic type as a string.
+   * @param options Pubsub options.
+   * @return Publish handle.
+   */
   public static int publish(
       int topic, int type, String typeStr, PubSubOption... options) {
     return publish(topic, type, typeStr, buildOptions(options));
   }
 
+  /**
+   * Publishes topic.
+   *
+   * @param topic Topic handle.
+   * @param type Topic type.
+   * @param typeStr Topic type as a string.
+   * @param properties Topic properties.
+   * @param options Pubsub options.
+   * @return Publish handle.
+   */
   public static native int publishEx(
       int topic, int type, String typeStr, String properties, PubSubOptions options);
 
+  /**
+   * Publishes topic.
+   *
+   * @param topic Topic handle.
+   * @param type Topic type.
+   * @param typeStr Topic type as a string.
+   * @param properties Topic properties.
+   * @param options Pubsub options.
+   * @return Publish handle.
+   */
   public static int publishEx(
       int topic, int type, String typeStr, String properties, PubSubOption... options) {
     return publishEx(topic, type, typeStr, properties, buildOptions(options));
   }
 
+  /**
+   * Unpublishes topic.
+   *
+   * @param pubentry Publish entry handle.
+   */
   public static native void unpublish(int pubentry);
 
+  /**
+   * Releases NT entry.
+   *
+   * @param entry NT entry handle.
+   */
   public static native void releaseEntry(int entry);
 
+  /**
+   * Relesaes pubsub entry.
+   *
+   * @param pubsubentry Pubsub entry handle.
+   */
   public static native void release(int pubsubentry);
 
+  /**
+   * Returns topic from pubsub entry handle.
+   *
+   * @param pubsubentry Pubsub entry handle.
+   * @return Topic handle.
+   */
   public static native int getTopicFromHandle(int pubsubentry);
 
+  /**
+   * Subscribes to multiple topics.
+   *
+   * @param inst NT instance handle.
+   * @param prefixes List of topic prefixes.
+   * @param options Pubsub options.
+   * @return Subscribe handle.
+   */
   public static native int subscribeMultiple(int inst, String[] prefixes, PubSubOptions options);
 
+  /**
+   * Subscribes to multiple topics.
+   *
+   * @param inst NT instance handle.
+   * @param prefixes List of topic prefixes.
+   * @param options Pubsub options.
+   * @return Subscribe handle.
+   */
   public static int subscribeMultiple(int inst, String[] prefixes, PubSubOption... options) {
     return subscribeMultiple(inst, prefixes, buildOptions(options));
   }
 
+  /**
+   * Unsubscribes from multiple topics.
+   *
+   * @param sub Subscribe handle.
+   */
   public static native void unsubscribeMultiple(int sub);
 {% for t in types %}
+  /**
+   * Returns timestamped topic value as an atomic {{ t.TypeName }}.
+   *
+   * @param subentry Subentry handle.
+   * @param defaultValue Default value.
+   * @return Timestamped topic value.
+   */
   public static native Timestamped{{ t.TypeName }} getAtomic{{ t.TypeName }}(
       int subentry, {{ t.java.ValueType }} defaultValue);
 
+  /**
+   * Returns queued timestamped topic values.
+   *
+   * @param subentry Subentry handle.
+   * @return List of timestamped topic values.
+   */
   public static native Timestamped{{ t.TypeName }}[] readQueue{{ t.TypeName }}(int subentry);
 
+  /**
+   * Returns queued topic values.
+   *
+   * @param subentry Subentry handle.
+   * @return List of topic values.
+   */
   public static native {{ t.java.ValueType }}[] readQueueValues{{ t.TypeName }}(int subentry);
 {% if t.TypeName == "Raw" %}
+  /**
+   * Sets raw topic value.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param value Raw value buffer.
+   * @return True if set succeeded.
+   */
   public static boolean setRaw(int entry, long time, byte[] value) {
     return setRaw(entry, time, value, 0, value.length);
   }
 
+  /**
+   * Sets raw topic value.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param value Raw value buffer.
+   * @param start Value's offset into buffer.
+   * @param len Length of value in buffer.
+   * @return True if set succeeded.
+   */
   public static native boolean setRaw(int entry, long time, byte[] value, int start, int len);
 
+  /**
+   * Sets raw topic value.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param value Raw value buffer.
+   * @return True if set succeeded.
+   */
   public static boolean setRaw(int entry, long time, ByteBuffer value) {
     int pos = value.position();
     return setRaw(entry, time, value, pos, value.capacity() - pos);
   }
 
+  /**
+   * Sets raw topic value.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param value Raw value buffer.
+   * @param start Value's offset into buffer.
+   * @param len Length of value in buffer.
+   * @return True if set succeeded.
+   */
   public static boolean setRaw(int entry, long time, ByteBuffer value, int start, int len) {
     if (value.isDirect()) {
       if (start < 0) {
@@ -234,23 +590,84 @@ public final class NetworkTablesJNI {
     }
   }
 
+  /**
+   * Sets raw topic value buffer.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param value Raw value buffer.
+   * @param start Value's offset into buffer.
+   * @param len Length of value in buffer.
+   * @return True if set succeeded.
+   */
   private static native boolean setRawBuffer(int entry, long time, ByteBuffer value, int start, int len);
 {% else %}
+  /**
+   * Sets topic value.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param value Topic value.
+   * @return True if set succeeded.
+   */
   public static native boolean set{{ t.TypeName }}(int entry, long time, {{ t.java.ValueType }} value);
 {% endif %}
+  /**
+   * Returns topic value.
+   *
+   * @param entry Entry handle.
+   * @param defaultValue Default value.
+   * @return Topic value.
+   */
   public static native {{ t.java.ValueType }} get{{ t.TypeName }}(int entry, {{ t.java.ValueType }} defaultValue);
 {% if t.TypeName == "Raw" %}
+  /**
+   * Sets default raw topic value.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param defaultValue Default value.
+   * @return True if set succeeded.
+   */
   public static boolean setDefaultRaw(int entry, long time, byte[] defaultValue) {
     return setDefaultRaw(entry, time, defaultValue, 0, defaultValue.length);
   }
 
+  /**
+   * Sets default raw topic value.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param defaultValue Default value.
+   * @param start Value's offset into buffer.
+   * @param len Length of value in buffer.
+   * @return True if set succeeded.
+   */
   public static native boolean setDefaultRaw(int entry, long time, byte[] defaultValue, int start, int len);
 
+  /**
+   * Sets default raw topic value.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param defaultValue Default value.
+   * @return True if set succeeded.
+   */
   public static boolean setDefaultRaw(int entry, long time, ByteBuffer defaultValue) {
     int pos = defaultValue.position();
     return setDefaultRaw(entry, time, defaultValue, pos, defaultValue.limit() - pos);
   }
 
+  /**
+   * Sets default raw topic value.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param defaultValue Default value.
+   * @param start Value's offset into buffer.
+   * @param len Length of value in buffer.
+   * @return True if set succeeded.
+   */
   public static boolean setDefaultRaw(int entry, long time, ByteBuffer defaultValue, int start, int len) {
     if (defaultValue.isDirect()) {
       if (start < 0) {
@@ -270,25 +687,91 @@ public final class NetworkTablesJNI {
     }
   }
 
+  /**
+   * Sets default raw topic value buffer.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param defaultValue Default value.
+   * @param start Value's offset into buffer.
+   * @param len Length of value in buffer.
+   * @return True if set succeeded.
+   */
   private static native boolean setDefaultRawBuffer(int entry, long time, ByteBuffer defaultValue, int start, int len);
 {% else %}
+  /**
+   * Sets default topic value.
+   *
+   * @param entry Entry handle.
+   * @param time Time in microseconds.
+   * @param defaultValue Default value.
+   * @return True if set succeeded.
+   */
   public static native boolean setDefault{{ t.TypeName }}(int entry, long time, {{ t.java.ValueType }} defaultValue);
 {% endif %}
 {% endfor %}
+  /**
+   * Returns queued subentry values.
+   *
+   * @param subentry Subentry handle.
+   * @return List of queued subentry values.
+   */
   public static native NetworkTableValue[] readQueueValue(int subentry);
 
+  /**
+   * Returns entry's NT value.
+   *
+   * @param entry Entry handle.
+   * @return Entry's NT value.
+   */
   public static native NetworkTableValue getValue(int entry);
 
+  /**
+   * Sets entry flags.
+   *
+   * @param entry Entry handle.
+   * @param flags Entry flags.
+   */
   public static native void setEntryFlags(int entry, int flags);
 
+  /**
+   * Returns entry flags.
+   *
+   * @param entry Entry handle.
+   * @return Entry flags.
+   */
   public static native int getEntryFlags(int entry);
 
+  /**
+   * Returns topic info.
+   *
+   * @param inst NT instance handle.
+   * @param topic Topic handle.
+   * @return Topic info.
+   */
   public static native TopicInfo getTopicInfo(NetworkTableInstance inst, int topic);
 
+  /**
+   * Creates a listener poller.
+   *
+   * @param inst NT instance handle.
+   * @return Listener poller handle.
+   */
   public static native int createListenerPoller(int inst);
 
+  /**
+   * Destroys listener poller.
+   *
+   * @param poller Listener poller handle.
+   */
   public static native void destroyListenerPoller(int poller);
 
+  /**
+   * Converts NT event kinds to mask.
+   *
+   * @param kinds Enum set of NT event kinds.
+   * @return NT event mask.
+   */
   private static int kindsToMask(EnumSet<NetworkTableEvent.Kind> kinds) {
     int mask = 0;
     for (NetworkTableEvent.Kind kind : kinds) {
@@ -297,80 +780,316 @@ public final class NetworkTablesJNI {
     return mask;
   }
 
+  /**
+   * Adds listener.
+   *
+   * @param poller Listener poller handle.
+   * @param prefixes Topic prefixes.
+   * @param kinds Enum set of NT event kinds.
+   * @return Listener handle.
+   */
   public static int addListener(int poller, String[] prefixes, EnumSet<NetworkTableEvent.Kind> kinds) {
     return addListener(poller, prefixes, kindsToMask(kinds));
   }
 
+  /**
+   * Adds listener.
+   *
+   * @param poller Listener poller handle.
+   * @param handle Topic handle.
+   * @param kinds Enum set of NT event kinds.
+   * @return Listener handle.
+   */
   public static int addListener(int poller, int handle, EnumSet<NetworkTableEvent.Kind> kinds) {
     return addListener(poller, handle, kindsToMask(kinds));
   }
 
+  /**
+   * Adds listener.
+   *
+   * @param poller Listener poller handle.
+   * @param prefixes Topic prefixes.
+   * @param mask NT event mask.
+   * @return Listener handle.
+   */
   public static native int addListener(int poller, String[] prefixes, int mask);
 
+  /**
+   * Adds listener.
+   *
+   * @param poller Listener poller handle.
+   * @param handle Topic handle.
+   * @param mask NT event mask.
+   * @return Listener handle.
+   */
   public static native int addListener(int poller, int handle, int mask);
 
+  /**
+   * Returns NT events from listener queue.
+   *
+   * @param inst NT instance handle.
+   * @param poller Listener poller handle.
+   * @return List of NT events.
+   */
   public static native NetworkTableEvent[] readListenerQueue(
       NetworkTableInstance inst, int poller);
 
+  /**
+   * Removes listener.
+   *
+   * @param listener Listener handle.
+   */
   public static native void removeListener(int listener);
 
+  /**
+   * Returns network mode.
+   *
+   * @param inst NT instance handle.
+   * @return Network mode.
+   */
   public static native int getNetworkMode(int inst);
 
+  /**
+   * Starts local-only operation. Prevents calls to startServer or startClient from taking effect.
+   * Has no effect if startServer or startClient has already been called.
+   *
+   * @param inst NT instance handle.
+   */
   public static native void startLocal(int inst);
 
+  /**
+   * Stops local-only operation. startServer or startClient can be called after this call to start
+   * a server or client.
+   *
+   * @param inst NT instance handle.
+   */
   public static native void stopLocal(int inst);
 
+  /**
+   * Starts a server using the specified filename, listening address, and port.
+   *
+   * @param inst NT instance handle.
+   * @param persistFilename the name of the persist file to use
+   * @param listenAddress the address to listen on, or empty to listen on any address
+   * @param port3 port to communicate over (NT3)
+   * @param port4 port to communicate over (NT4)
+   */
   public static native void startServer(
       int inst, String persistFilename, String listenAddress, int port3, int port4);
 
+  /**
+   * Stops the server if it is running.
+   *
+   * @param inst NT instance handle.
+   */
   public static native void stopServer(int inst);
 
+  /**
+   * Starts a NT3 client. Use SetServer or SetServerTeam to set the server name and port.
+   *
+   * @param inst NT instance handle.
+   * @param identity network identity to advertise (cannot be empty string)
+   */
   public static native void startClient3(int inst, String identity);
 
+  /**
+   * Starts a NT4 client. Use SetServer or SetServerTeam to set the server name and port.
+   *
+   * @param inst NT instance handle.
+   * @param identity network identity to advertise (cannot be empty string)
+   */
   public static native void startClient4(int inst, String identity);
 
+  /**
+   * Stops the client if it is running.
+   *
+   * @param inst NT instance handle.
+   */
   public static native void stopClient(int inst);
 
+  /**
+   * Sets server address and port for client (without restarting client).
+   *
+   * @param inst NT instance handle.
+   * @param serverName server name
+   * @param port port to communicate over
+   */
   public static native void setServer(int inst, String serverName, int port);
 
+  /**
+   * Sets server addresses and ports for client (without restarting client). The client will
+   * attempt to connect to each server in round robin fashion.
+   *
+   * @param inst NT instance handle.
+   * @param serverNames array of server names
+   * @param ports array of port numbers (0=default)
+   */
   public static native void setServer(int inst, String[] serverNames, int[] ports);
 
+  /**
+   * Sets server addresses and port for client (without restarting client). Connects using commonly
+   * known robot addresses for the specified team.
+   *
+   * @param inst NT instance handle.
+   * @param team team number
+   * @param port port to communicate over
+   */
   public static native void setServerTeam(int inst, int team, int port);
 
+  /**
+   * Disconnects the client if it's running and connected. This will automatically start
+   * reconnection attempts to the current server list.
+   *
+   * @param inst NT instance handle.
+   */
   public static native void disconnect(int inst);
 
+  /**
+   * Starts requesting server address from Driver Station. This connects to the Driver Station
+   * running on localhost to obtain the server IP address.
+   *
+   * @param inst NT instance handle.
+   * @param port server port to use in combination with IP from DS
+   */
   public static native void startDSClient(int inst, int port);
 
+  /**
+   * Stops requesting server address from Driver Station.
+   *
+   * @param inst NT instance handle.
+   */
   public static native void stopDSClient(int inst);
 
+  /**
+   * Flushes all updated values immediately to the local client/server. This does not flush to the
+   * network.
+   *
+   * @param inst NT instance handle.
+   */
   public static native void flushLocal(int inst);
 
+  /**
+   * Flushes all updated values immediately to the network. Note: This is rate-limited to protect
+   * the network from flooding. This is primarily useful for synchronizing network updates with
+   * user code.
+   *
+   * @param inst NT instance handle.
+   */
   public static native void flush(int inst);
 
+  /**
+   * Gets information on the currently established network connections. If operating as a client,
+   * this will return either zero or one values.
+   *
+   * @param inst NT instance handle.
+   * @return array of connection information
+   */
   public static native ConnectionInfo[] getConnections(int inst);
 
+  /**
+   * Return whether or not the instance is connected to another node.
+   *
+   * @param inst NT instance handle.
+   * @return True if connected.
+   */
   public static native boolean isConnected(int inst);
 
+  /**
+   * Get the time offset between server time and local time. Add this value to local time to get
+   * the estimated equivalent server time. In server mode, this always returns 0. In client mode,
+   * this returns the time offset only if the client and server are connected and have exchanged
+   * synchronization messages. Note the time offset may change over time as it is periodically
+   * updated; to receive updates as events, add a listener to the "time sync" event.
+   *
+   * @param inst NT instance handle.
+   * @return Time offset in microseconds (optional)
+   */
   public static native OptionalLong getServerTimeOffset(int inst);
 
+  /**
+   * Returns the current timestamp in microseconds.
+   *
+   * @return The current timestsamp in microseconds.
+   */
   public static native long now();
 
+  /**
+   * Starts logging entry changes to a DataLog.
+   *
+   * @param inst NT instance handle.
+   * @param log data log handle; lifetime must extend until StopEntryDataLog is called or the
+   *     instance is destroyed
+   * @param prefix only store entries with names that start with this prefix; the prefix is not
+   *     included in the data log entry name
+   * @param logPrefix prefix to add to data log entry names
+   * @return Data logger handle
+   */
   private static native int startEntryDataLog(int inst, long log, String prefix, String logPrefix);
 
+  /**
+   * Starts logging entry changes to a DataLog.
+   *
+   * @param inst NT instance handle.
+   * @param log data log object; lifetime must extend until StopEntryDataLog is called or the
+   *     instance is destroyed
+   * @param prefix only store entries with names that start with this prefix; the prefix is not
+   *     included in the data log entry name
+   * @param logPrefix prefix to add to data log entry names
+   * @return Data logger handle
+   */
   public static int startEntryDataLog(int inst, DataLog log, String prefix, String logPrefix) {
     return startEntryDataLog(inst, log.getImpl(), prefix, logPrefix);
   }
 
+  /**
+   * Stops logging entry changes to a DataLog.
+   *
+   * @param logger data logger handle
+   */
   public static native void stopEntryDataLog(int logger);
 
+  /**
+   * Starts logging connection changes to a DataLog.
+   *
+   * @param inst NT instance handle.
+   * @param log data log handle; lifetime must extend until StopConnectionDataLog is called or the
+   *     instance is destroyed
+   * @param name data log entry name
+   * @return Data logger handle
+   */
   private static native int startConnectionDataLog(int inst, long log, String name);
 
+  /**
+   * Starts logging connection changes to a DataLog.
+   *
+   * @param inst NT instance handle.
+   * @param log data log object; lifetime must extend until StopConnectionDataLog is called or the
+   *     instance is destroyed
+   * @param name data log entry name
+   * @return Data logger handle
+   */
   public static int startConnectionDataLog(int inst, DataLog log, String name) {
     return startConnectionDataLog(inst, log.getImpl(), name);
   }
 
+  /**
+   * Stops logging connection changes to a DataLog.
+   *
+   * @param logger data logger handle
+   */
   public static native void stopConnectionDataLog(int logger);
 
+  /**
+   * Add logger callback function. By default, log messages are sent to stderr; this function sends
+   * log messages with the specified levels to the provided callback function instead. The callback
+   * function will only be called for log messages with level greater than or equal to minLevel and
+   * less than or equal to maxLevel; messages outside this range will be silently ignored.
+   *
+   * @param poller Listener poller handle.
+   * @param minLevel minimum log level
+   * @param maxLevel maximum log level
+   * @return Listener handle
+   */
   public static native int addLogger(int poller, int minLevel, int maxLevel);
 
   /** Utility class. */

ntcore/src/generated/main/java/edu/wpi/first/networktables/GenericPublisher.java

@@ -517,6 +517,12 @@ public interface GenericPublisher extends Publisher, Consumer<NetworkTableValue>
    */
   boolean setDefaultBooleanArray(boolean[] defaultValue);
 
+  /**
+   * Sets the entry's value if it does not exist.
+   *
+   * @param defaultValue the default value to set
+   * @return False if the entry exists with a different type
+   */
   boolean setDefaultBooleanArray(Boolean[] defaultValue);
 
 
@@ -528,6 +534,12 @@ public interface GenericPublisher extends Publisher, Consumer<NetworkTableValue>
    */
   boolean setDefaultIntegerArray(long[] defaultValue);
 
+  /**
+   * Sets the entry's value if it does not exist.
+   *
+   * @param defaultValue the default value to set
+   * @return False if the entry exists with a different type
+   */
   boolean setDefaultIntegerArray(Long[] defaultValue);
 
 
@@ -539,6 +551,12 @@ public interface GenericPublisher extends Publisher, Consumer<NetworkTableValue>
    */
   boolean setDefaultFloatArray(float[] defaultValue);
 
+  /**
+   * Sets the entry's value if it does not exist.
+   *
+   * @param defaultValue the default value to set
+   * @return False if the entry exists with a different type
+   */
   boolean setDefaultFloatArray(Float[] defaultValue);
 
 
@@ -550,6 +568,12 @@ public interface GenericPublisher extends Publisher, Consumer<NetworkTableValue>
    */
   boolean setDefaultDoubleArray(double[] defaultValue);
 
+  /**
+   * Sets the entry's value if it does not exist.
+   *
+   * @param defaultValue the default value to set
+   * @return False if the entry exists with a different type
+   */
   boolean setDefaultDoubleArray(Double[] defaultValue);
 
 

ntcore/src/generated/main/java/edu/wpi/first/networktables/NetworkTableInstance.java

@@ -68,6 +68,11 @@ public final class NetworkTableInstance implements AutoCloseable {
       this.value = value;
     }
 
+    /**
+     * Returns the network mode value.
+     *
+     * @return The network mode value.
+     */
     public int getValue() {
       return value;
     }

ntcore/src/main/java/edu/wpi/first/networktables/EntryBase.java

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

ntcore/src/main/java/edu/wpi/first/networktables/LogMessage.java

@@ -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. */

ntcore/src/main/java/edu/wpi/first/networktables/NTSendableBuilder.java

@@ -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

ntcore/src/main/java/edu/wpi/first/networktables/NetworkTableEvent.java

@@ -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;
     }

ntcore/src/main/java/edu/wpi/first/networktables/NetworkTableType.java

@@ -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;
   }

ntcore/src/main/java/edu/wpi/first/networktables/ProtobufTopic.java

@@ -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;
   }

ntcore/src/main/java/edu/wpi/first/networktables/StructArrayTopic.java

@@ -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;
   }

ntcore/src/main/java/edu/wpi/first/networktables/StructTopic.java

@@ -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;
   }

ntcore/src/main/java/edu/wpi/first/networktables/Topic.java

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

ntcore/src/main/native/include/networktables/NTSendableBuilder.h

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

ntcore/src/main/native/include/networktables/Topic.h

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