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

@@ -7,7 +7,7 @@
/// @file
/// Provides a convenient wrapper to throw an exception when a condition is
/// unmet. This is similar to an assertion, but uses exceptions instead of
/// ::abort(), and cannot be disabled.
/// std::abort(), and cannot be disabled.
namespace drake {
namespace internal {