Namespace documentation

jkeiser · jkeiser · commit 45bccadfa9a9 · 2020-09-17T09:47:31.000-07:00
diff --git a/include/simdjson.h b/include/simdjson.h
@@ -85,8 +85,18 @@ SIMDJSON_DISABLE_UNDESIRED_WARNINGS
 #include "simdjson/westmere.h"
 
 namespace simdjson {
+  /**
+   * Represents the best statically linked simdjson implementation that can be used by the compiling
+   * program.
+   * 
+   * Detects what options the program is compiled against, and picks the minimum implementation that
+   * will work on any computer that can run the program. For example, if you compile with g++
+   * -march=westmere, it will pick the westmere implementation. The haswell implementation will
+   * still be available, and can be selected at runtime, but the builtin implementation (and any
+   * code that uses it) will use westmere.
+   */
   namespace builtin = SIMDJSON_BUILTIN_IMPLEMENTATION;
-}
+} // namespace simdjson
 
 SIMDJSON_POP_DISABLE_WARNINGS
 
diff --git a/include/simdjson/arm64.h b/include/simdjson/arm64.h
@@ -5,6 +5,14 @@
 
 #if SIMDJSON_IMPLEMENTATION_ARM64
 
+namespace simdjson {
+/**
+ * Implementation for NEON (ARMv8).
+ */
+namespace arm64 {
+} // namespace arm64
+} // namespace simdjson
+
 #include "simdjson/arm64/implementation.h"
 
 #include "simdjson/arm64/begin.h"
diff --git a/include/simdjson/fallback.h b/include/simdjson/fallback.h
@@ -5,6 +5,14 @@
 
 #if SIMDJSON_IMPLEMENTATION_FALLBACK
 
+namespace simdjson {
+/**
+ * Fallback implementation (runs on any machine).
+ */
+namespace fallback {
+} // namespace fallback
+} // namespace simdjson
+
 #include "simdjson/fallback/implementation.h"
 
 #include "simdjson/fallback/begin.h"
diff --git a/include/simdjson/generic/atomparsing.h b/include/simdjson/generic/atomparsing.h
@@ -1,6 +1,7 @@
 namespace simdjson {
 namespace SIMDJSON_IMPLEMENTATION {
 namespace {
+/// @private
 namespace atomparsing {
 
 // The string_to_uint32 is exclusively used to map literal strings to 32-bit values.
diff --git a/include/simdjson/generic/numberparsing.h b/include/simdjson/generic/numberparsing.h
@@ -5,6 +5,7 @@
 namespace simdjson {
 namespace SIMDJSON_IMPLEMENTATION {
 namespace {
+/// @private
 namespace numberparsing {
 
 using internal::FASTFLOAT_LARGEST_POWER;
diff --git a/include/simdjson/generic/ondemand.h b/include/simdjson/generic/ondemand.h
@@ -1,3 +1,15 @@
+namespace simdjson {
+namespace SIMDJSON_IMPLEMENTATION {
+/**
+ * A fast, simple, DOM-like interface that parses JSON as you use it.
+ * 
+ * Designed for maximum speed and a lower memory profile.
+ */
+namespace ondemand {
+} // namespace ondemand
+} // namespace SIMDJSON_IMPLEMENTATION
+} // namespace simdjson
+
 #include "simdjson/generic/ondemand/logger.h"
 #include "simdjson/generic/ondemand/raw_json_string.h"
 #include "simdjson/generic/ondemand/token_iterator.h"
diff --git a/include/simdjson/generic/stringparsing.h b/include/simdjson/generic/stringparsing.h
@@ -4,6 +4,7 @@
 namespace simdjson {
 namespace SIMDJSON_IMPLEMENTATION {
 namespace {
+/// @private
 namespace stringparsing {
 
 // begin copypasta
diff --git a/include/simdjson/haswell.h b/include/simdjson/haswell.h
@@ -7,6 +7,14 @@
 
 #define SIMDJSON_TARGET_HASWELL SIMDJSON_TARGET_REGION("avx2,bmi,pclmul,lzcnt")
 
+namespace simdjson {
+/**
+ * Implementation for Haswell (Intel AVX2).
+ */
+namespace haswell {
+} // namespace haswell
+} // namespace simdjson
+
 //
 // These two need to be included outside SIMDJSON_TARGET_REGION
 //
diff --git a/include/simdjson/westmere.h b/include/simdjson/westmere.h
@@ -7,6 +7,14 @@
 
 #define SIMDJSON_TARGET_WESTMERE SIMDJSON_TARGET_REGION("sse4.2,pclmul")
 
+namespace simdjson {
+/**
+ * Implementation for Westmere (Intel SSE4.2).
+ */
+namespace westmere {
+} // namespace westmere
+} // namespace simdjson
+
 //
 // These two need to be included outside SIMDJSON_TARGET_REGION
 //
