Fix documentation warnings generated by JavaDoc (NFC) (#3428)

Some C++ Doxygen comments were updated to reflect any wording changes.

See `rg "(@return|@param \w+) TODO" | less` for list of incomplete docs.
This commit is contained in:
Tyler Veness
2021-06-10 20:46:47 -07:00
committed by GitHub
parent 9e1b7e0464
commit 4d9ff76433
108 changed files with 1113 additions and 429 deletions

View File

@@ -366,7 +366,11 @@ public final class NetworkTable {
return getEntry(key).getValue();
}
/** Get the path of the NetworkTable. */
/**
* Get the path of the NetworkTable.
*
* @return The path of the NetworkTable.
*/
public String getPath() {
return m_path;
}

View File

@@ -40,7 +40,11 @@ public final class NetworkTablesJNI {
}
}
/** Force load the library. */
/**
* Force load the library.
*
* @throws IOException if the library fails to load
*/
public static synchronized void forceLoad() throws IOException {
if (libraryLoaded) {
return;