diff --git a/Doxyfile b/Doxyfile index 56178f763..9b3872bda 100644 --- a/Doxyfile +++ b/Doxyfile @@ -829,7 +829,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = doc include +INPUT = doc include/simdjson include/simdjson/dom include/simdjson/generic # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -1246,7 +1246,9 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = + +HTML_EXTRA_STYLESHEET = theme/doxygen-awesome.css \ + theme/doxygen-awesome-sidebar-only.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1256,7 +1258,7 @@ HTML_EXTRA_STYLESHEET = # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = +HTML_EXTRA_FILES = theme/doxygen-awesome-darkmode-toggle.js # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to @@ -1543,7 +1545,7 @@ DISABLE_INDEX = NO # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. diff --git a/include/simdjson/arm64/implementation.h b/include/simdjson/arm64/implementation.h index ba16f6027..ed7489c69 100644 --- a/include/simdjson/arm64/implementation.h +++ b/include/simdjson/arm64/implementation.h @@ -12,6 +12,9 @@ using namespace simdjson; using namespace simdjson::dom; } +/** + * @private + */ class implementation final : public simdjson::implementation { public: simdjson_inline implementation() : simdjson::implementation("arm64", "ARM NEON", internal::instruction_set::NEON) {} diff --git a/include/simdjson/fallback/implementation.h b/include/simdjson/fallback/implementation.h index 30891ec4e..508f396b9 100644 --- a/include/simdjson/fallback/implementation.h +++ b/include/simdjson/fallback/implementation.h @@ -11,6 +11,9 @@ using namespace simdjson; using namespace simdjson::dom; } +/** + * @private + */ class implementation final : public simdjson::implementation { public: simdjson_inline implementation() : simdjson::implementation( diff --git a/include/simdjson/haswell/implementation.h b/include/simdjson/haswell/implementation.h index 5b88353fc..226b4eac4 100644 --- a/include/simdjson/haswell/implementation.h +++ b/include/simdjson/haswell/implementation.h @@ -9,6 +9,9 @@ namespace haswell { using namespace simdjson; +/** + * @private + */ class implementation final : public simdjson::implementation { public: simdjson_inline implementation() : simdjson::implementation( diff --git a/include/simdjson/icelake/implementation.h b/include/simdjson/icelake/implementation.h index 4040b5f12..a821bd025 100644 --- a/include/simdjson/icelake/implementation.h +++ b/include/simdjson/icelake/implementation.h @@ -9,6 +9,9 @@ namespace icelake { using namespace simdjson; +/** + * @private + */ class implementation final : public simdjson::implementation { public: simdjson_inline implementation() : simdjson::implementation( diff --git a/include/simdjson/ppc64/implementation.h b/include/simdjson/ppc64/implementation.h index ab4d5a499..e6bca299a 100644 --- a/include/simdjson/ppc64/implementation.h +++ b/include/simdjson/ppc64/implementation.h @@ -12,6 +12,9 @@ using namespace simdjson; using namespace simdjson::dom; } // namespace +/** + * @private + */ class implementation final : public simdjson::implementation { public: simdjson_inline implementation() diff --git a/include/simdjson/westmere/implementation.h b/include/simdjson/westmere/implementation.h index ee3362486..d2e962f25 100644 --- a/include/simdjson/westmere/implementation.h +++ b/include/simdjson/westmere/implementation.h @@ -12,6 +12,9 @@ using namespace simdjson; using namespace simdjson::dom; } +/** + * @private + */ class implementation final : public simdjson::implementation { public: simdjson_inline implementation() : simdjson::implementation("westmere", "Intel/AMD SSE4.2", internal::instruction_set::SSE42 | internal::instruction_set::PCLMULQDQ) {} diff --git a/tools/prepare_doxygen.sh b/tools/prepare_doxygen.sh new file mode 100755 index 000000000..85ec9f8c4 --- /dev/null +++ b/tools/prepare_doxygen.sh @@ -0,0 +1,21 @@ +#!/bin/sh +set -e + +PACKAGE_URL="https://github.com/jothepro/doxygen-awesome-css.git" +PACKAGE_VERSION="v2.1.0" + +BASE_DIR=$(pwd) +THEME_DIR="$BASE_DIR/theme" +WORKSPACE=$(mktemp -d 2> /dev/null || mktemp -d -t 'tmp') +cleanup () { + EXIT_CODE=$? + [ -d "$WORKSPACE" ] && rm -rf "$WORKSPACE" + exit $EXIT_CODE +} + +trap cleanup INT TERM EXIT + +cd "$WORKSPACE" +git clone --depth=1 --branch "$PACKAGE_VERSION" "$PACKAGE_URL" theme +rm -rf "$THEME_DIR" +mv "$WORKSPACE/theme" "$BASE_DIR"