From 9408fd5176728b64e7bd5cf9ec2797e768544644 Mon Sep 17 00:00:00 2001 From: Peter Johnson Date: Sun, 29 Jul 2018 12:49:28 -0700 Subject: [PATCH] Add Doxygen comments for namespaces (#1245) --- cscore/src/main/native/include/cscore_cpp.h | 1 + hal/src/main/native/include/hal/cpp/fpga_clock.h | 1 + ntcore/src/main/native/include/ntcore_cpp.h | 1 + wpilibc/src/main/native/include/frc/Base.h | 1 + wpiutil/src/main/native/include/wpi/jni_util.h | 3 +++ wpiutil/src/main/native/include/wpi/json.h | 8 ++++---- 6 files changed, 11 insertions(+), 4 deletions(-) diff --git a/cscore/src/main/native/include/cscore_cpp.h b/cscore/src/main/native/include/cscore_cpp.h index 45a0fa40c2..924817f969 100644 --- a/cscore/src/main/native/include/cscore_cpp.h +++ b/cscore/src/main/native/include/cscore_cpp.h @@ -24,6 +24,7 @@ namespace cv { class Mat; } // namespace cv +/** CameraServer (cscore) namespace */ namespace cs { /** diff --git a/hal/src/main/native/include/hal/cpp/fpga_clock.h b/hal/src/main/native/include/hal/cpp/fpga_clock.h index 5097190df1..b217fdc636 100644 --- a/hal/src/main/native/include/hal/cpp/fpga_clock.h +++ b/hal/src/main/native/include/hal/cpp/fpga_clock.h @@ -10,6 +10,7 @@ #include #include +/** WPILib Hardware Abstraction Layer (HAL) namespace */ namespace hal { /** diff --git a/ntcore/src/main/native/include/ntcore_cpp.h b/ntcore/src/main/native/include/ntcore_cpp.h index 2683d4a89f..56cb5afe17 100644 --- a/ntcore/src/main/native/include/ntcore_cpp.h +++ b/ntcore/src/main/native/include/ntcore_cpp.h @@ -25,6 +25,7 @@ #include "networktables/NetworkTableValue.h" +/** NetworkTables (ntcore) namespace */ namespace nt { /** diff --git a/wpilibc/src/main/native/include/frc/Base.h b/wpilibc/src/main/native/include/frc/Base.h index f851bdd7d5..2dc96b9827 100644 --- a/wpilibc/src/main/native/include/frc/Base.h +++ b/wpilibc/src/main/native/include/frc/Base.h @@ -19,6 +19,7 @@ static_assert(0, "Visual Studio 2015 or greater required."); #define DEFAULT_MOVE_CONSTRUCTOR(ClassName) ClassName(ClassName&&) = default +/** WPILib FRC namespace */ namespace frc { // A struct to use as a deleter when a std::shared_ptr must wrap a raw pointer diff --git a/wpiutil/src/main/native/include/wpi/jni_util.h b/wpiutil/src/main/native/include/wpi/jni_util.h index e56418d192..9b20ad2e2a 100644 --- a/wpiutil/src/main/native/include/wpi/jni_util.h +++ b/wpiutil/src/main/native/include/wpi/jni_util.h @@ -26,7 +26,10 @@ #include "wpi/mutex.h" #include "wpi/raw_ostream.h" +/** WPILib C++ utilities (wpiutil) namespace */ namespace wpi { + +/** Java Native Interface (JNI) utility functions */ namespace java { // Gets a Java stack trace. Also provides the last function diff --git a/wpiutil/src/main/native/include/wpi/json.h b/wpiutil/src/main/native/include/wpi/json.h index c2d3a13e5e..a3aa7762a5 100644 --- a/wpiutil/src/main/native/include/wpi/json.h +++ b/wpiutil/src/main/native/include/wpi/json.h @@ -1080,9 +1080,9 @@ struct from_json_fn }; } -/// namespace to hold default `from_json` function -/// to see why this is required: -/// http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4381.html +// namespace to hold default `from_json` function +// to see why this is required: +// http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4381.html namespace { constexpr const auto& from_json = detail::static_const::value; @@ -1400,7 +1400,7 @@ struct to_json_fn }; } -/// namespace to hold default `to_json` function +// namespace to hold default `to_json` function namespace { constexpr const auto& to_json = detail::static_const::value;