Minor Doxygen improvements and fixes (#847)

Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>
sourcemeta · Oct 8, 2024 · d27ae67 · d27ae67
1 parent 2a6872d
commit d27ae67
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 38 deletions.
diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in
@@ -2210,7 +2210,10 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = DOXYGEN
+PREDEFINED             += SOURCEMETA_JSONBINPACK_NUMERIC_EXPORT=
+PREDEFINED             += SOURCEMETA_JSONBINPACK_COMPILER_EXPORT=
+PREDEFINED             += SOURCEMETA_JSONBINPACK_RUNTIME_EXPORT=
+PREDEFINED             += DOXYGEN
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
@@ -2219,7 +2222,9 @@ PREDEFINED             = DOXYGEN
 # definition found in the source code.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-EXPAND_AS_DEFINED      =
+EXPAND_AS_DEFINED      += SOURCEMETA_JSONBINPACK_NUMERIC_EXPORT
+EXPAND_AS_DEFINED      += SOURCEMETA_JSONBINPACK_COMPILER_EXPORT
+EXPAND_AS_DEFINED      += SOURCEMETA_JSONBINPACK_RUNTIME_EXPORT
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
 # remove all references to function-like macros that are alone on a line, have

diff --git a/doxygen/schemas.markdown b/doxygen/schemas.markdown
diff --git a/doxygen/todo.markdown b/doxygen/todo.markdown
@@ -5,14 +5,6 @@ JSON BinPack is under heavy development. This page aims to document what's
 missing. If you want to fund JSON BinPack's development, please consider
 [becoming a sponsor](https://github.com/sponsors/sourcemeta).
 
-Canonicalizer
--------------
-
-Defined in @ref compiler.
-
-- `TypeUnionAnyOf`: Resolve known bugs
-- Perform JSON Schema bundling
-
 Mapper
 ------
 
@@ -30,21 +22,21 @@ Encodings
 
 Defined in @ref runtime.
 
-| Encoding                             | Type             | Notes                  |
-|--------------------------------------|------------------|------------------------|
-| `ONEOF_CHOICE_INDEX_PREFIX`          | @ref plan_any    | Missing implementation |
-| `BOUNDED_TYPED_LENGTH_PREFIX`        | @ref plan_array  | Missing implementation |
-| `REQUIRED_ONLY_BOUNDED_TYPED_OBJECT` | @ref plan_object | Missing implementation |
-| `NON_REQUIRED_BOUNDED_TYPED_OBJECT`  | @ref plan_object | Missing implementation |
-| `MIXED_BOUNDED_TYPED_OBJECT`         | @ref plan_object | Missing implementation |
-| `REQUIRED_UNBOUNDED_TYPED_OBJECT`    | @ref plan_object | Missing implementation |
-| `OPTIONAL_UNBOUNDED_TYPED_OBJECT`    | @ref plan_object | Missing implementation |
-| `MIXED_UNBOUNDED_TYPED_OBJECT`       | @ref plan_object | Missing implementation |
-| `PACKED_BOUNDED_REQUIRED_OBJECT`     | @ref plan_object | Missing implementation |
-| `PACKED_UNBOUNDED_OBJECT`            | @ref plan_object | Missing implementation |
-| `URL_PROTOCOL_HOST_REST`             | @ref plan_string | Missing implementation |
-| `STRING_BROTLI`                      | @ref plan_string | Missing implementation |
-| `STRING_DICTIONARY_COMPRESSOR`       | @ref plan_string | Missing implementation |
+| Encoding                             | Type                 | Notes                  |
+|--------------------------------------|----------------------|------------------------|
+| `ONEOF_CHOICE_INDEX_PREFIX`          | @ref encoding_any    | Missing implementation |
+| `BOUNDED_TYPED_LENGTH_PREFIX`        | @ref encoding_array  | Missing implementation |
+| `REQUIRED_ONLY_BOUNDED_TYPED_OBJECT` | @ref encoding_object | Missing implementation |
+| `NON_REQUIRED_BOUNDED_TYPED_OBJECT`  | @ref encoding_object | Missing implementation |
+| `MIXED_BOUNDED_TYPED_OBJECT`         | @ref encoding_object | Missing implementation |
+| `REQUIRED_UNBOUNDED_TYPED_OBJECT`    | @ref encoding_object | Missing implementation |
+| `OPTIONAL_UNBOUNDED_TYPED_OBJECT`    | @ref encoding_object | Missing implementation |
+| `MIXED_UNBOUNDED_TYPED_OBJECT`       | @ref encoding_object | Missing implementation |
+| `PACKED_BOUNDED_REQUIRED_OBJECT`     | @ref encoding_object | Missing implementation |
+| `PACKED_UNBOUNDED_OBJECT`            | @ref encoding_object | Missing implementation |
+| `URL_PROTOCOL_HOST_REST`             | @ref encoding_string | Missing implementation |
+| `STRING_BROTLI`                      | @ref encoding_string | Missing implementation |
+| `STRING_DICTIONARY_COMPRESSOR`       | @ref encoding_string | Missing implementation |
 
 JSON Schema keywords
 --------------------