From 18379073b6497f677a20bfeced95b511f82c3355 Mon Sep 17 00:00:00 2001 From: David Medina Date: Wed, 15 Sep 2021 21:22:54 -0400 Subject: [PATCH] [Docs] Regenerate docs for v1.2.0 release (#517) --- Makefile | 2 ++ docs/api/device/buildKernel.md | 2 +- docs/api/device/buildKernelFromString.md | 2 +- docs/api/device/constructor.md | 6 +++--- docs/api/device/createStream.md | 2 +- docs/api/device/dontUseRefs.md | 2 +- docs/api/device/finish.md | 2 +- docs/api/device/free.md | 2 +- docs/api/device/getStream.md | 2 +- docs/api/device/hasSeparateMemorySpace.md | 2 +- docs/api/device/hash.md | 2 +- docs/api/device/isInitialized.md | 2 +- docs/api/device/malloc.md | 12 ++++++------ docs/api/device/memoryAllocated.md | 2 +- docs/api/device/memorySize.md | 2 +- docs/api/device/mode.md | 2 +- docs/api/device/operator_equals.md | 4 ++-- docs/api/device/properties.md | 2 +- docs/api/device/setStream.md | 2 +- docs/api/device/setup.md | 4 ++-- docs/api/device/tagStream.md | 2 +- docs/api/device/timeBetween.md | 2 +- docs/api/device/waitFor.md | 2 +- docs/api/device/wrapMemory.md | 4 ++-- docs/api/dtype_t/addField.md | 2 +- docs/api/dtype_t/bytes.md | 2 +- docs/api/dtype_t/canBeCastedTo.md | 2 +- docs/api/dtype_t/isStruct.md | 2 +- docs/api/dtype_t/isTuple.md | 2 +- docs/api/dtype_t/matches.md | 2 +- docs/api/dtype_t/name.md | 2 +- docs/api/dtype_t/operator_bracket.md | 4 ++-- docs/api/dtype_t/operator_equals.md | 4 ++-- docs/api/dtype_t/registerType.md | 2 +- docs/api/dtype_t/structFieldCount.md | 2 +- docs/api/dtype_t/structFieldNames.md | 2 +- docs/api/dtype_t/tupleSize.md | 2 +- docs/api/function/argumentCount.md | 2 +- docs/api/function/getArgTypes.md | 2 +- docs/api/function/getReturnType.md | 2 +- docs/api/function/operator_parentheses.md | 2 +- docs/api/hash_t/fromString.md | 2 +- docs/api/hash_t/getFullString.md | 2 +- docs/api/hash_t/getInt.md | 2 +- docs/api/hash_t/getString.md | 4 ++-- docs/api/hash_t/isInitialized.md | 2 +- docs/api/hash_t/operator_equals.md | 4 ++-- docs/api/hash_t/operator_less_than.md | 2 +- docs/api/hash_t/operator_xor.md | 4 ++-- docs/api/json/asArray.md | 2 +- docs/api/json/asBoolean.md | 2 +- docs/api/json/asNull.md | 2 +- docs/api/json/asNumber.md | 2 +- docs/api/json/asObject.md | 2 +- docs/api/json/asString.md | 2 +- docs/api/json/dump.md | 2 +- docs/api/json/get.md | 4 ++-- docs/api/json/has.md | 2 +- docs/api/json/isArray.md | 2 +- docs/api/json/isBool.md | 2 +- docs/api/json/isNull.md | 2 +- docs/api/json/isNumber.md | 2 +- docs/api/json/isObject.md | 2 +- docs/api/json/isString.md | 2 +- docs/api/json/keys.md | 2 +- docs/api/json/operator_brackets.md | 8 ++++---- docs/api/json/operator_equals.md | 2 +- docs/api/json/parse.md | 4 ++-- docs/api/json/read.md | 2 +- docs/api/json/remove.md | 4 ++-- docs/api/json/set.md | 2 +- docs/api/json/size.md | 2 +- docs/api/json/value.md | 2 +- docs/api/json/write.md | 2 +- docs/api/kernel/binaryFilename.md | 2 +- docs/api/kernel/clearArgs.md | 2 +- docs/api/kernel/dontUseRefs.md | 2 +- docs/api/kernel/free.md | 2 +- docs/api/kernel/getDevice.md | 2 +- docs/api/kernel/hash.md | 2 +- docs/api/kernel/isInitialized.md | 2 +- docs/api/kernel/mode.md | 2 +- docs/api/kernel/name.md | 2 +- docs/api/kernel/operator_equals.md | 4 ++-- docs/api/kernel/operator_parentheses.md | 2 +- docs/api/kernel/properties.md | 2 +- docs/api/kernel/pushArg.md | 2 +- docs/api/kernel/run.md | 4 ++-- docs/api/kernel/setRunDims.md | 2 +- docs/api/kernel/sourceFilename.md | 2 +- docs/api/memory/cast.md | 2 +- docs/api/memory/clone.md | 2 +- docs/api/memory/copyFrom.md | 8 ++++---- docs/api/memory/copyTo.md | 8 ++++---- docs/api/memory/dtype.md | 2 +- docs/api/memory/free.md | 2 +- docs/api/memory/getDevice.md | 2 +- docs/api/memory/isInitialized.md | 2 +- docs/api/memory/length.md | 4 ++-- docs/api/memory/mode.md | 2 +- docs/api/memory/operator_add.md | 4 ++-- docs/api/memory/operator_equals.md | 4 ++-- docs/api/memory/operator_kernelArg.md | 2 +- docs/api/memory/properties.md | 2 +- docs/api/memory/ptr.md | 4 ++-- docs/api/memory/size.md | 2 +- docs/api/memory/slice.md | 2 +- docs/api/stream/free.md | 2 +- docs/api/stream/getDevice.md | 2 +- docs/api/stream/isInitialized.md | 2 +- docs/api/stream/mode.md | 2 +- docs/api/stream/operator_equals.md | 4 ++-- docs/api/stream/properties.md | 2 +- docs/api/streamTag/free.md | 2 +- docs/api/streamTag/getDevice.md | 2 +- docs/api/streamTag/isInitialized.md | 2 +- docs/api/streamTag/operator_equals.md | 4 ++-- docs/api/streamTag/wait.md | 2 +- include/occa/core/kernel.hpp | 2 ++ include/occa/core/kernelOperators.hpp_codegen | 2 -- scripts/codegen/setup_kernel_operators.py | 3 ++- scripts/docs/api_docgen/system_commands.py | 2 +- scripts/docs/api_docgen/xml_utils.py | 19 ++++++++++++++++--- 123 files changed, 175 insertions(+), 159 deletions(-) diff --git a/Makefile b/Makefile index 7bef8ab23..6b9986680 100644 --- a/Makefile +++ b/Makefile @@ -284,6 +284,8 @@ print-%: #---[ Documentation ]----------------------------- # Auto-generate the API documentation +.PHONY: docs + docs: @${OCCA_DIR}/scripts/docs/api-docgen #================================================= diff --git a/docs/api/device/buildKernel.md b/docs/api/device/buildKernel.md index 2c2e112dc..a47508816 100644 --- a/docs/api/device/buildKernel.md +++ b/docs/api/device/buildKernel.md @@ -20,7 +20,7 @@ const occa::json &props )
- Source + Source
diff --git a/docs/api/device/buildKernelFromString.md b/docs/api/device/buildKernelFromString.md index 648011761..5cd3c9087 100644 --- a/docs/api/device/buildKernelFromString.md +++ b/docs/api/device/buildKernelFromString.md @@ -20,7 +20,7 @@ const occa::json &props )
- Source + Source
diff --git a/docs/api/device/constructor.md b/docs/api/device/constructor.md index 870c6ee87..8314f181b 100644 --- a/docs/api/device/constructor.md +++ b/docs/api/device/constructor.md @@ -16,7 +16,7 @@ )
- Source + Source
@@ -35,7 +35,7 @@ const std::string &props )
- Source + Source
@@ -63,7 +63,7 @@ const occa::json &props )
- Source + Source
diff --git a/docs/api/device/createStream.md b/docs/api/device/createStream.md index 460efdd6e..2f629b958 100644 --- a/docs/api/device/createStream.md +++ b/docs/api/device/createStream.md @@ -16,7 +16,7 @@ const occa::json &props )
- Source + Source
diff --git a/docs/api/device/dontUseRefs.md b/docs/api/device/dontUseRefs.md index a2c790b7f..4cf4ad5cf 100644 --- a/docs/api/device/dontUseRefs.md +++ b/docs/api/device/dontUseRefs.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/device/finish.md b/docs/api/device/finish.md index 36f773d53..b7b77cff1 100644 --- a/docs/api/device/finish.md +++ b/docs/api/device/finish.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/device/free.md b/docs/api/device/free.md index eab8d21d7..564ef568f 100644 --- a/docs/api/device/free.md +++ b/docs/api/device/free.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/device/getStream.md b/docs/api/device/getStream.md index c5f2a0bc8..86c803a62 100644 --- a/docs/api/device/getStream.md +++ b/docs/api/device/getStream.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/device/hasSeparateMemorySpace.md b/docs/api/device/hasSeparateMemorySpace.md index 2122649fd..7f6781693 100644 --- a/docs/api/device/hasSeparateMemorySpace.md +++ b/docs/api/device/hasSeparateMemorySpace.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/device/hash.md b/docs/api/device/hash.md index 0d0a273a9..37ba11be7 100644 --- a/docs/api/device/hash.md +++ b/docs/api/device/hash.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/device/isInitialized.md b/docs/api/device/isInitialized.md index c0d2f54d9..8990e71bf 100644 --- a/docs/api/device/isInitialized.md +++ b/docs/api/device/isInitialized.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/device/malloc.md b/docs/api/device/malloc.md index 093c95441..353d7a4e2 100644 --- a/docs/api/device/malloc.md +++ b/docs/api/device/malloc.md @@ -22,7 +22,7 @@ const occa::json &props )
- Source + Source
@@ -40,7 +40,7 @@ const occa::json &props )
- Source + Source @@ -56,7 +56,7 @@ const occa::json &props )
- Source + Source
@@ -105,7 +105,7 @@ const occa::json &props )
- Source + Source
@@ -123,7 +123,7 @@ const occa::json &props )
- Source + Source @@ -139,7 +139,7 @@ const occa::json &props )
- Source + Source
diff --git a/docs/api/device/memoryAllocated.md b/docs/api/device/memoryAllocated.md index 59c138563..96ed659ab 100644 --- a/docs/api/device/memoryAllocated.md +++ b/docs/api/device/memoryAllocated.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/device/memorySize.md b/docs/api/device/memorySize.md index 37b0d1f50..2ffbf9bb3 100644 --- a/docs/api/device/memorySize.md +++ b/docs/api/device/memorySize.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/device/mode.md b/docs/api/device/mode.md index 4f416cc3f..1c0b5fec5 100644 --- a/docs/api/device/mode.md +++ b/docs/api/device/mode.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/device/operator_equals.md b/docs/api/device/operator_equals.md index c189ffaa4..aa85f41dd 100644 --- a/docs/api/device/operator_equals.md +++ b/docs/api/device/operator_equals.md @@ -16,7 +16,7 @@ const occa::device &other )
- Source + Source
@@ -36,7 +36,7 @@ const occa::device &other )
- Source + Source
diff --git a/docs/api/device/properties.md b/docs/api/device/properties.md index ff0254374..e4eb679f6 100644 --- a/docs/api/device/properties.md +++ b/docs/api/device/properties.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/device/setStream.md b/docs/api/device/setStream.md index 97e0bf7c6..e39e10179 100644 --- a/docs/api/device/setStream.md +++ b/docs/api/device/setStream.md @@ -16,7 +16,7 @@ occa::stream s )
- Source + Source diff --git a/docs/api/device/setup.md b/docs/api/device/setup.md index b6dfb7245..e8bbcb6ed 100644 --- a/docs/api/device/setup.md +++ b/docs/api/device/setup.md @@ -16,7 +16,7 @@ const std::string &props )
- Source + Source @@ -28,7 +28,7 @@ const occa::json &props )
- Source + Source diff --git a/docs/api/device/tagStream.md b/docs/api/device/tagStream.md index d99a1e32c..2330f0b2f 100644 --- a/docs/api/device/tagStream.md +++ b/docs/api/device/tagStream.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/device/timeBetween.md b/docs/api/device/timeBetween.md index f7fdd36ab..149cf419c 100644 --- a/docs/api/device/timeBetween.md +++ b/docs/api/device/timeBetween.md @@ -18,7 +18,7 @@ const occa::streamTag &endTag )
- Source + Source
diff --git a/docs/api/device/waitFor.md b/docs/api/device/waitFor.md index 73a6d7089..6762d2b1e 100644 --- a/docs/api/device/waitFor.md +++ b/docs/api/device/waitFor.md @@ -16,7 +16,7 @@ occa::streamTag tag )
- Source + Source
diff --git a/docs/api/device/wrapMemory.md b/docs/api/device/wrapMemory.md index 3daf4045e..d02514afc 100644 --- a/docs/api/device/wrapMemory.md +++ b/docs/api/device/wrapMemory.md @@ -22,7 +22,7 @@ const occa::json &props )
- Source + Source
@@ -52,7 +52,7 @@ const occa::json &props )
- Source + Source
diff --git a/docs/api/dtype_t/addField.md b/docs/api/dtype_t/addField.md index 994129400..d17ff0cc6 100644 --- a/docs/api/dtype_t/addField.md +++ b/docs/api/dtype_t/addField.md @@ -20,7 +20,7 @@ const int tupleSize_ )
- Source + Source
diff --git a/docs/api/dtype_t/bytes.md b/docs/api/dtype_t/bytes.md index 8eb2dcdfe..3e6a13d54 100644 --- a/docs/api/dtype_t/bytes.md +++ b/docs/api/dtype_t/bytes.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/dtype_t/canBeCastedTo.md b/docs/api/dtype_t/canBeCastedTo.md index 61dc5e2d7..2ef5264db 100644 --- a/docs/api/dtype_t/canBeCastedTo.md +++ b/docs/api/dtype_t/canBeCastedTo.md @@ -16,7 +16,7 @@ const occa::dtype_t &other )
- Source + Source diff --git a/docs/api/dtype_t/isStruct.md b/docs/api/dtype_t/isStruct.md index 2c0848f9e..686fad122 100644 --- a/docs/api/dtype_t/isStruct.md +++ b/docs/api/dtype_t/isStruct.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/dtype_t/isTuple.md b/docs/api/dtype_t/isTuple.md index 9fa52a313..11d55a3a0 100644 --- a/docs/api/dtype_t/isTuple.md +++ b/docs/api/dtype_t/isTuple.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/dtype_t/matches.md b/docs/api/dtype_t/matches.md index 864415763..0d0e71f6e 100644 --- a/docs/api/dtype_t/matches.md +++ b/docs/api/dtype_t/matches.md @@ -16,7 +16,7 @@ const occa::dtype_t &other )
- Source + Source diff --git a/docs/api/dtype_t/name.md b/docs/api/dtype_t/name.md index 0a1bc0337..f0e37a584 100644 --- a/docs/api/dtype_t/name.md +++ b/docs/api/dtype_t/name.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/dtype_t/operator_bracket.md b/docs/api/dtype_t/operator_bracket.md index 7afa8d0ec..2c89a920d 100644 --- a/docs/api/dtype_t/operator_bracket.md +++ b/docs/api/dtype_t/operator_bracket.md @@ -16,7 +16,7 @@ const int field )
- Source + Source @@ -28,7 +28,7 @@ const std::string &field )
- Source + Source diff --git a/docs/api/dtype_t/operator_equals.md b/docs/api/dtype_t/operator_equals.md index 118a91b44..95be238b3 100644 --- a/docs/api/dtype_t/operator_equals.md +++ b/docs/api/dtype_t/operator_equals.md @@ -16,7 +16,7 @@ const occa::dtype_t &other )
- Source + Source @@ -28,7 +28,7 @@ const occa::dtype_t &other )
- Source + Source diff --git a/docs/api/dtype_t/registerType.md b/docs/api/dtype_t/registerType.md index 9aa734d59..bf1c5f488 100644 --- a/docs/api/dtype_t/registerType.md +++ b/docs/api/dtype_t/registerType.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/dtype_t/structFieldCount.md b/docs/api/dtype_t/structFieldCount.md index 4de56990b..1a835fbc7 100644 --- a/docs/api/dtype_t/structFieldCount.md +++ b/docs/api/dtype_t/structFieldCount.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/dtype_t/structFieldNames.md b/docs/api/dtype_t/structFieldNames.md index 0ed002942..256c44efd 100644 --- a/docs/api/dtype_t/structFieldNames.md +++ b/docs/api/dtype_t/structFieldNames.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/dtype_t/tupleSize.md b/docs/api/dtype_t/tupleSize.md index fec4c173a..bf08e4c2e 100644 --- a/docs/api/dtype_t/tupleSize.md +++ b/docs/api/dtype_t/tupleSize.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/function/argumentCount.md b/docs/api/function/argumentCount.md index add0aff43..85e47d757 100644 --- a/docs/api/function/argumentCount.md +++ b/docs/api/function/argumentCount.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/function/getArgTypes.md b/docs/api/function/getArgTypes.md index 7f76346df..e5745c605 100644 --- a/docs/api/function/getArgTypes.md +++ b/docs/api/function/getArgTypes.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/function/getReturnType.md b/docs/api/function/getReturnType.md index f55864595..07d32635a 100644 --- a/docs/api/function/getReturnType.md +++ b/docs/api/function/getReturnType.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/function/operator_parentheses.md b/docs/api/function/operator_parentheses.md index bc60b43dc..e13165a4d 100644 --- a/docs/api/function/operator_parentheses.md +++ b/docs/api/function/operator_parentheses.md @@ -15,7 +15,7 @@ ReturnType operator () (ArgTypes... args )
- Source + Source diff --git a/docs/api/hash_t/fromString.md b/docs/api/hash_t/fromString.md index 555a306b3..8d47a2593 100644 --- a/docs/api/hash_t/fromString.md +++ b/docs/api/hash_t/fromString.md @@ -16,7 +16,7 @@ const std::string &s )
- Source + Source diff --git a/docs/api/hash_t/getFullString.md b/docs/api/hash_t/getFullString.md index 057ef78e0..7ecb58b75 100644 --- a/docs/api/hash_t/getFullString.md +++ b/docs/api/hash_t/getFullString.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/hash_t/getInt.md b/docs/api/hash_t/getInt.md index 0aa6fba55..7b8eb3fef 100644 --- a/docs/api/hash_t/getInt.md +++ b/docs/api/hash_t/getInt.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/hash_t/getString.md b/docs/api/hash_t/getString.md index bb279577f..df89b7400 100644 --- a/docs/api/hash_t/getString.md +++ b/docs/api/hash_t/getString.md @@ -16,7 +16,7 @@ )
- Source + Source @@ -28,7 +28,7 @@ )
- Source + Source diff --git a/docs/api/hash_t/isInitialized.md b/docs/api/hash_t/isInitialized.md index 44a616c55..90df29e54 100644 --- a/docs/api/hash_t/isInitialized.md +++ b/docs/api/hash_t/isInitialized.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/hash_t/operator_equals.md b/docs/api/hash_t/operator_equals.md index 487004202..bab900879 100644 --- a/docs/api/hash_t/operator_equals.md +++ b/docs/api/hash_t/operator_equals.md @@ -16,7 +16,7 @@ const occa::hash_t &fo )
- Source + Source @@ -28,7 +28,7 @@ const occa::hash_t &fo )
- Source + Source diff --git a/docs/api/hash_t/operator_less_than.md b/docs/api/hash_t/operator_less_than.md index ff355e6c7..c2f073a40 100644 --- a/docs/api/hash_t/operator_less_than.md +++ b/docs/api/hash_t/operator_less_than.md @@ -16,7 +16,7 @@ const occa::hash_t &fo )
- Source + Source diff --git a/docs/api/hash_t/operator_xor.md b/docs/api/hash_t/operator_xor.md index 46e443435..1037f54dc 100644 --- a/docs/api/hash_t/operator_xor.md +++ b/docs/api/hash_t/operator_xor.md @@ -18,7 +18,7 @@ const T &t )
- Source + Source
@@ -38,7 +38,7 @@ const occa::hash_t hash )
- Source + Source
diff --git a/docs/api/json/asArray.md b/docs/api/json/asArray.md index cf8c5c86f..0c6325537 100644 --- a/docs/api/json/asArray.md +++ b/docs/api/json/asArray.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/json/asBoolean.md b/docs/api/json/asBoolean.md index c188a727b..f9767d541 100644 --- a/docs/api/json/asBoolean.md +++ b/docs/api/json/asBoolean.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/asNull.md b/docs/api/json/asNull.md index 48e952886..0114dca90 100644 --- a/docs/api/json/asNull.md +++ b/docs/api/json/asNull.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/asNumber.md b/docs/api/json/asNumber.md index 1e30d2784..b2169f860 100644 --- a/docs/api/json/asNumber.md +++ b/docs/api/json/asNumber.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/asObject.md b/docs/api/json/asObject.md index 65513c456..2db22a1db 100644 --- a/docs/api/json/asObject.md +++ b/docs/api/json/asObject.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/asString.md b/docs/api/json/asString.md index 7b35953e3..9e4832650 100644 --- a/docs/api/json/asString.md +++ b/docs/api/json/asString.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/dump.md b/docs/api/json/dump.md index 7f9e5e931..56cf06fa2 100644 --- a/docs/api/json/dump.md +++ b/docs/api/json/dump.md @@ -16,7 +16,7 @@ const int indent )
- Source + Source diff --git a/docs/api/json/get.md b/docs/api/json/get.md index f67f7862c..500432a1a 100644 --- a/docs/api/json/get.md +++ b/docs/api/json/get.md @@ -20,7 +20,7 @@ const T &default_ )
- Source + Source @@ -36,7 +36,7 @@ const T &default_ )
- Source + Source diff --git a/docs/api/json/has.md b/docs/api/json/has.md index 1238cbf1c..d58173329 100644 --- a/docs/api/json/has.md +++ b/docs/api/json/has.md @@ -16,7 +16,7 @@ const std::string &key )
- Source + Source diff --git a/docs/api/json/isArray.md b/docs/api/json/isArray.md index 574ff4115..33465b8e8 100644 --- a/docs/api/json/isArray.md +++ b/docs/api/json/isArray.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/isBool.md b/docs/api/json/isBool.md index 64ceffb9d..652ca083e 100644 --- a/docs/api/json/isBool.md +++ b/docs/api/json/isBool.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/isNull.md b/docs/api/json/isNull.md index d7ce3a20a..c19f66e2c 100644 --- a/docs/api/json/isNull.md +++ b/docs/api/json/isNull.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/isNumber.md b/docs/api/json/isNumber.md index 6814a2654..377e624c9 100644 --- a/docs/api/json/isNumber.md +++ b/docs/api/json/isNumber.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/isObject.md b/docs/api/json/isObject.md index 73e0cf575..d7cf85e01 100644 --- a/docs/api/json/isObject.md +++ b/docs/api/json/isObject.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/isString.md b/docs/api/json/isString.md index 0f2593e04..47c0a0662 100644 --- a/docs/api/json/isString.md +++ b/docs/api/json/isString.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/keys.md b/docs/api/json/keys.md index 589140f9b..b5db610b9 100644 --- a/docs/api/json/keys.md +++ b/docs/api/json/keys.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/operator_brackets.md b/docs/api/json/operator_brackets.md index ed2b60abc..8c837e10f 100644 --- a/docs/api/json/operator_brackets.md +++ b/docs/api/json/operator_brackets.md @@ -16,7 +16,7 @@ const std::string &s )
- Source + Source @@ -28,7 +28,7 @@ const std::string &s )
- Source + Source
@@ -47,7 +47,7 @@ const int n )
- Source + Source
@@ -59,7 +59,7 @@ const int n )
- Source + Source
diff --git a/docs/api/json/operator_equals.md b/docs/api/json/operator_equals.md index d1b35f266..9fbd5fbbe 100644 --- a/docs/api/json/operator_equals.md +++ b/docs/api/json/operator_equals.md @@ -16,7 +16,7 @@ const occa::json &j )
- Source + Source
diff --git a/docs/api/json/parse.md b/docs/api/json/parse.md index d484f1583..15ae7514b 100644 --- a/docs/api/json/parse.md +++ b/docs/api/json/parse.md @@ -16,7 +16,7 @@ const char *&c )
- Source + Source @@ -28,7 +28,7 @@ const std::string &s )
- Source + Source diff --git a/docs/api/json/read.md b/docs/api/json/read.md index 734dbdb32..2a02c7483 100644 --- a/docs/api/json/read.md +++ b/docs/api/json/read.md @@ -16,7 +16,7 @@ const std::string &filename )
- Source + Source diff --git a/docs/api/json/remove.md b/docs/api/json/remove.md index c81ea7709..2071f0dd9 100644 --- a/docs/api/json/remove.md +++ b/docs/api/json/remove.md @@ -16,7 +16,7 @@ const char *c )
- Source + Source @@ -28,7 +28,7 @@ const std::string &s )
- Source + Source diff --git a/docs/api/json/set.md b/docs/api/json/set.md index 565988472..8ef6f235e 100644 --- a/docs/api/json/set.md +++ b/docs/api/json/set.md @@ -20,7 +20,7 @@ const T &value )
- Source + Source diff --git a/docs/api/json/size.md b/docs/api/json/size.md index f50144dfa..679fc389b 100644 --- a/docs/api/json/size.md +++ b/docs/api/json/size.md @@ -20,7 +20,7 @@ const T &value )
- Source + Source diff --git a/docs/api/json/value.md b/docs/api/json/value.md index bf89ea20c..8bbccf849 100644 --- a/docs/api/json/value.md +++ b/docs/api/json/value.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/json/write.md b/docs/api/json/write.md index 5d3aff194..b83915486 100644 --- a/docs/api/json/write.md +++ b/docs/api/json/write.md @@ -16,7 +16,7 @@ const std::string &filename )
- Source + Source diff --git a/docs/api/kernel/binaryFilename.md b/docs/api/kernel/binaryFilename.md index ec932e3b4..58b5c421b 100644 --- a/docs/api/kernel/binaryFilename.md +++ b/docs/api/kernel/binaryFilename.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/kernel/clearArgs.md b/docs/api/kernel/clearArgs.md index d24ee5ad2..82f9ed38f 100644 --- a/docs/api/kernel/clearArgs.md +++ b/docs/api/kernel/clearArgs.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/kernel/dontUseRefs.md b/docs/api/kernel/dontUseRefs.md index ca4ec2a89..fabf98aff 100644 --- a/docs/api/kernel/dontUseRefs.md +++ b/docs/api/kernel/dontUseRefs.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/kernel/free.md b/docs/api/kernel/free.md index 0186132f5..f7130e49d 100644 --- a/docs/api/kernel/free.md +++ b/docs/api/kernel/free.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/kernel/getDevice.md b/docs/api/kernel/getDevice.md index a79da3cce..f3b0cee3e 100644 --- a/docs/api/kernel/getDevice.md +++ b/docs/api/kernel/getDevice.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/kernel/hash.md b/docs/api/kernel/hash.md index 7a9cf25ab..1013b83b1 100644 --- a/docs/api/kernel/hash.md +++ b/docs/api/kernel/hash.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/kernel/isInitialized.md b/docs/api/kernel/isInitialized.md index 2f8bebd16..88ac9b751 100644 --- a/docs/api/kernel/isInitialized.md +++ b/docs/api/kernel/isInitialized.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/kernel/mode.md b/docs/api/kernel/mode.md index 42c2f6b50..68bfc98c8 100644 --- a/docs/api/kernel/mode.md +++ b/docs/api/kernel/mode.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/kernel/name.md b/docs/api/kernel/name.md index bb9602c13..ac83d57b0 100644 --- a/docs/api/kernel/name.md +++ b/docs/api/kernel/name.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/kernel/operator_equals.md b/docs/api/kernel/operator_equals.md index b9ed10c2d..ef6c19c01 100644 --- a/docs/api/kernel/operator_equals.md +++ b/docs/api/kernel/operator_equals.md @@ -16,7 +16,7 @@ const occa::kernel &other )
- Source + Source
@@ -36,7 +36,7 @@ const occa::kernel &other )
- Source + Source
diff --git a/docs/api/kernel/operator_parentheses.md b/docs/api/kernel/operator_parentheses.md index 47c314101..389968bd7 100644 --- a/docs/api/kernel/operator_parentheses.md +++ b/docs/api/kernel/operator_parentheses.md @@ -15,7 +15,7 @@ void operator () ([occa::kernelArg](/api/kernelArg)... args )
- Source + Source
diff --git a/docs/api/kernel/properties.md b/docs/api/kernel/properties.md index 4caf23b78..368bc8086 100644 --- a/docs/api/kernel/properties.md +++ b/docs/api/kernel/properties.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/kernel/pushArg.md b/docs/api/kernel/pushArg.md index d40971b87..d8f0ca578 100644 --- a/docs/api/kernel/pushArg.md +++ b/docs/api/kernel/pushArg.md @@ -16,7 +16,7 @@ const occa::kernelArg &arg )
- Source + Source diff --git a/docs/api/kernel/run.md b/docs/api/kernel/run.md index aeaea8444..2d0e2b4dd 100644 --- a/docs/api/kernel/run.md +++ b/docs/api/kernel/run.md @@ -16,7 +16,7 @@ )
- Source + Source @@ -28,7 +28,7 @@ std::initializer_list< occa::kernelArg >args )
- Source + Source diff --git a/docs/api/kernel/setRunDims.md b/docs/api/kernel/setRunDims.md index d484bf2af..7d5b05344 100644 --- a/docs/api/kernel/setRunDims.md +++ b/docs/api/kernel/setRunDims.md @@ -18,7 +18,7 @@ dim innerDims )
- Source + Source diff --git a/docs/api/kernel/sourceFilename.md b/docs/api/kernel/sourceFilename.md index db1dd733d..d977a74b0 100644 --- a/docs/api/kernel/sourceFilename.md +++ b/docs/api/kernel/sourceFilename.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/memory/cast.md b/docs/api/memory/cast.md index e08aff187..278cd48a7 100644 --- a/docs/api/memory/cast.md +++ b/docs/api/memory/cast.md @@ -16,7 +16,7 @@ const occa::dtype_t &dtype_ )
- Source + Source
diff --git a/docs/api/memory/clone.md b/docs/api/memory/clone.md index ea34e2cb6..fbd05fe08 100644 --- a/docs/api/memory/clone.md +++ b/docs/api/memory/clone.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/memory/copyFrom.md b/docs/api/memory/copyFrom.md index abdc50c4c..ca21dd0ce 100644 --- a/docs/api/memory/copyFrom.md +++ b/docs/api/memory/copyFrom.md @@ -22,7 +22,7 @@ const occa::json &props )
- Source + Source @@ -36,7 +36,7 @@ const occa::json &props )
- Source + Source
@@ -84,7 +84,7 @@ For example, `async: true`. ::: const occa::json &props )
- Source + Source
@@ -98,7 +98,7 @@ For example, `async: true`. ::: const occa::json &props )
- Source + Source
diff --git a/docs/api/memory/copyTo.md b/docs/api/memory/copyTo.md index 389c4de3d..ac000f424 100644 --- a/docs/api/memory/copyTo.md +++ b/docs/api/memory/copyTo.md @@ -22,7 +22,7 @@ const occa::json &props )
- Source + Source
@@ -36,7 +36,7 @@ const occa::json &props )
- Source + Source
@@ -84,7 +84,7 @@ For example, `async: true`. ::: const occa::json &props )
- Source + Source
@@ -98,7 +98,7 @@ For example, `async: true`. ::: const occa::json &props )
- Source + Source
diff --git a/docs/api/memory/dtype.md b/docs/api/memory/dtype.md index d49b1c512..3b6abbbe3 100644 --- a/docs/api/memory/dtype.md +++ b/docs/api/memory/dtype.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/memory/free.md b/docs/api/memory/free.md index f22e66dc1..48cadfb9a 100644 --- a/docs/api/memory/free.md +++ b/docs/api/memory/free.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/memory/getDevice.md b/docs/api/memory/getDevice.md index 9dbc54c3a..9169aac25 100644 --- a/docs/api/memory/getDevice.md +++ b/docs/api/memory/getDevice.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/memory/isInitialized.md b/docs/api/memory/isInitialized.md index a56007d39..9c02a50b7 100644 --- a/docs/api/memory/isInitialized.md +++ b/docs/api/memory/isInitialized.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/memory/length.md b/docs/api/memory/length.md index f8e724e6b..03fd31458 100644 --- a/docs/api/memory/length.md +++ b/docs/api/memory/length.md @@ -16,7 +16,7 @@ )
- Source + Source
@@ -32,7 +32,7 @@ )
- Source + Source
diff --git a/docs/api/memory/mode.md b/docs/api/memory/mode.md index 1fc740e0c..f689f5736 100644 --- a/docs/api/memory/mode.md +++ b/docs/api/memory/mode.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/memory/operator_add.md b/docs/api/memory/operator_add.md index ab5ac6bf6..4589b6c44 100644 --- a/docs/api/memory/operator_add.md +++ b/docs/api/memory/operator_add.md @@ -16,7 +16,7 @@ const dim_t offset )
- Source + Source
@@ -28,7 +28,7 @@ const dim_t offset )
- Source + Source
diff --git a/docs/api/memory/operator_equals.md b/docs/api/memory/operator_equals.md index bf64734bd..08b44aca9 100644 --- a/docs/api/memory/operator_equals.md +++ b/docs/api/memory/operator_equals.md @@ -16,7 +16,7 @@ const occa::memory &other )
- Source + Source
@@ -36,7 +36,7 @@ const occa::memory &other )
- Source + Source
diff --git a/docs/api/memory/operator_kernelArg.md b/docs/api/memory/operator_kernelArg.md index ba8d99049..10d0b876c 100644 --- a/docs/api/memory/operator_kernelArg.md +++ b/docs/api/memory/operator_kernelArg.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/memory/properties.md b/docs/api/memory/properties.md index ca4e67efb..28853d313 100644 --- a/docs/api/memory/properties.md +++ b/docs/api/memory/properties.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/memory/ptr.md b/docs/api/memory/ptr.md index 69f12b1fb..12c123706 100644 --- a/docs/api/memory/ptr.md +++ b/docs/api/memory/ptr.md @@ -18,7 +18,7 @@ )
- Source + Source @@ -32,7 +32,7 @@ )
- Source + Source diff --git a/docs/api/memory/size.md b/docs/api/memory/size.md index bd61e6d5f..e4325b77c 100644 --- a/docs/api/memory/size.md +++ b/docs/api/memory/size.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/memory/slice.md b/docs/api/memory/slice.md index 7b246a58f..9a9f97171 100644 --- a/docs/api/memory/slice.md +++ b/docs/api/memory/slice.md @@ -18,7 +18,7 @@ const dim_t count )
- Source + Source diff --git a/docs/api/stream/free.md b/docs/api/stream/free.md index 258e59d87..1662e2131 100644 --- a/docs/api/stream/free.md +++ b/docs/api/stream/free.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/stream/getDevice.md b/docs/api/stream/getDevice.md index 10c8ea28e..fbb58fe81 100644 --- a/docs/api/stream/getDevice.md +++ b/docs/api/stream/getDevice.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/stream/isInitialized.md b/docs/api/stream/isInitialized.md index d20b5d45d..3983631e8 100644 --- a/docs/api/stream/isInitialized.md +++ b/docs/api/stream/isInitialized.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/stream/mode.md b/docs/api/stream/mode.md index 8e4a85b72..882e4b592 100644 --- a/docs/api/stream/mode.md +++ b/docs/api/stream/mode.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/stream/operator_equals.md b/docs/api/stream/operator_equals.md index e50751d1b..09787cf9a 100644 --- a/docs/api/stream/operator_equals.md +++ b/docs/api/stream/operator_equals.md @@ -16,7 +16,7 @@ const occa::stream &other )
- Source + Source
@@ -36,7 +36,7 @@ const occa::stream &other )
- Source + Source
diff --git a/docs/api/stream/properties.md b/docs/api/stream/properties.md index 871db5aa3..02857838e 100644 --- a/docs/api/stream/properties.md +++ b/docs/api/stream/properties.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/streamTag/free.md b/docs/api/streamTag/free.md index 39b0e1833..897b3d653 100644 --- a/docs/api/streamTag/free.md +++ b/docs/api/streamTag/free.md @@ -16,7 +16,7 @@ )
- Source + Source diff --git a/docs/api/streamTag/getDevice.md b/docs/api/streamTag/getDevice.md index e2b17bd43..eafeb52e1 100644 --- a/docs/api/streamTag/getDevice.md +++ b/docs/api/streamTag/getDevice.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/streamTag/isInitialized.md b/docs/api/streamTag/isInitialized.md index 56063687a..124ce47ff 100644 --- a/docs/api/streamTag/isInitialized.md +++ b/docs/api/streamTag/isInitialized.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/docs/api/streamTag/operator_equals.md b/docs/api/streamTag/operator_equals.md index 4dadfe0ed..f86686f95 100644 --- a/docs/api/streamTag/operator_equals.md +++ b/docs/api/streamTag/operator_equals.md @@ -16,7 +16,7 @@ const occa::streamTag &other )
- Source + Source
@@ -36,7 +36,7 @@ const occa::streamTag &other )
- Source + Source
diff --git a/docs/api/streamTag/wait.md b/docs/api/streamTag/wait.md index 3076976d3..d4416d091 100644 --- a/docs/api/streamTag/wait.md +++ b/docs/api/streamTag/wait.md @@ -16,7 +16,7 @@ )
- Source + Source
diff --git a/include/occa/core/kernel.hpp b/include/occa/core/kernel.hpp index 52867ac51..8085462bc 100644 --- a/include/occa/core/kernel.hpp +++ b/include/occa/core/kernel.hpp @@ -294,6 +294,8 @@ namespace occa { * * @endDoc */ + void operator () () const; + #include "kernelOperators.hpp_codegen" /** diff --git a/include/occa/core/kernelOperators.hpp_codegen b/include/occa/core/kernelOperators.hpp_codegen index d9f75e1e8..8c98b2600 100644 --- a/include/occa/core/kernelOperators.hpp_codegen +++ b/include/occa/core/kernelOperators.hpp_codegen @@ -3,8 +3,6 @@ // EDIT: scripts/codegen/setup_kernel_operators.py // ========================================= -void operator () () const; - void operator () (const kernelArg &arg1) const; void operator () (const kernelArg &arg1, const kernelArg &arg2) const; diff --git a/scripts/codegen/setup_kernel_operators.py b/scripts/codegen/setup_kernel_operators.py index 89072a40d..33962e24b 100755 --- a/scripts/codegen/setup_kernel_operators.py +++ b/scripts/codegen/setup_kernel_operators.py @@ -103,8 +103,9 @@ def run_function_from_argument(N): @to_file('include/occa/core/kernelOperators.hpp_codegen') def operator_declarations(N): + # We manually define the 0-argument kernel for documentation purposes return '\n\n'.join( - operator_declaration(n) for n in range(N + 1) + operator_declaration(n + 1) for n in range(N) ) diff --git a/scripts/docs/api_docgen/system_commands.py b/scripts/docs/api_docgen/system_commands.py index b8d684a36..9dd1af8ff 100644 --- a/scripts/docs/api_docgen/system_commands.py +++ b/scripts/docs/api_docgen/system_commands.py @@ -94,5 +94,5 @@ def get_git_hash(): with the proper Github commit hash ''' return subprocess.check_output( - 'git rev-parse --short HEAD'.split(' ') + 'git rev-parse --short origin/main'.split(' ') ).decode('utf-8').strip() diff --git a/scripts/docs/api_docgen/xml_utils.py b/scripts/docs/api_docgen/xml_utils.py index f538c7199..b0dcb7c7f 100644 --- a/scripts/docs/api_docgen/xml_utils.py +++ b/scripts/docs/api_docgen/xml_utils.py @@ -13,9 +13,22 @@ def parse_xml_file(filename: str) -> Tuple[Any, Any]: ''' Return the top-level objects from an lxml-parsed file ''' - tree = et.parse( - os.path.expanduser(filename) - ) + filename = os.path.expanduser(filename) + + # Super janky replacement of CDATA to avoid Doxygen parsing issues + with open(filename, 'r') as fd: + content = ''.join( + line + for line in fd.readlines() + if ( + 'rawXmlStart=' not in line + and 'rawXmlEnd=' not in line + ) + ) + with open(filename, 'w') as fd: + fd.write(content) + + tree = et.parse(filename) root = tree.getroot() return (tree, root)