[Docs] Regenerate docs for v1.2.0 release (#517)

libocca · Sep 16, 2021 · 1837907 · 1837907
1 parent 7d02eac
commit 1837907
Show file tree

Hide file tree

Showing 123 changed files with 175 additions and 159 deletions.
diff --git 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
@@ -20,7 +20,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L513" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L513" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/buildKernelFromString.md b/docs/api/device/buildKernelFromString.md
@@ -20,7 +20,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L537" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L537" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/constructor.md b/docs/api/device/constructor.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L130" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L130" target="_blank">Source</a>
     </div>
     <div class="description">
 
@@ -35,7 +35,7 @@
     <span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L144" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L144" target="_blank">Source</a>
     </div>
     <div class="description">
 
@@ -63,7 +63,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L158" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L158" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/createStream.md b/docs/api/device/createStream.md
@@ -16,7 +16,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L377" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L377" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/dontUseRefs.md b/docs/api/device/dontUseRefs.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L185" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L185" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/device/finish.md b/docs/api/device/finish.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L343" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L343" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/device/free.md b/docs/api/device/free.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L256" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L256" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/device/getStream.md b/docs/api/device/getStream.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L390" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L390" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/hasSeparateMemorySpace.md b/docs/api/device/hasSeparateMemorySpace.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L359" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L359" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/hash.md b/docs/api/device/hash.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L306" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L306" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/isInitialized.md b/docs/api/device/isInitialized.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L224" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L224" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/malloc.md b/docs/api/device/malloc.md
@@ -22,7 +22,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L578" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L578" target="_blank">Source</a>
     </div>
 
   </div>
@@ -40,7 +40,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L586" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L586" target="_blank">Source</a>
     </div>
 
   </div>
@@ -56,7 +56,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L594" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L594" target="_blank">Source</a>
     </div>
     <div class="description">
 
@@ -105,7 +105,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L618" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L618" target="_blank">Source</a>
     </div>
 
   </div>
@@ -123,7 +123,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L626" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L626" target="_blank">Source</a>
     </div>
 
   </div>
@@ -139,7 +139,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L634" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L634" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/memoryAllocated.md b/docs/api/device/memoryAllocated.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L332" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L332" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/device/memorySize.md b/docs/api/device/memorySize.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L319" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L319" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/device/mode.md b/docs/api/device/mode.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L269" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L269" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/operator_equals.md b/docs/api/device/operator_equals.md
@@ -16,7 +16,7 @@
     <span class="token keyword">const</span> <a href="#/api/device/">occa::device</a> &amp;other
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L198" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L198" target="_blank">Source</a>
     </div>
     <div class="description">
 
@@ -36,7 +36,7 @@
     <span class="token keyword">const</span> <a href="#/api/device/">occa::device</a> &amp;other
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L211" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L211" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/properties.md b/docs/api/device/properties.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L282" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L282" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/device/setStream.md b/docs/api/device/setStream.md
@@ -16,7 +16,7 @@
     <a href="#/api/stream/">occa::stream</a> s
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L400" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L400" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/device/setup.md b/docs/api/device/setup.md
@@ -16,7 +16,7 @@
     <span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L236" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L236" target="_blank">Source</a>
     </div>
 
   </div>
@@ -28,7 +28,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L241" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L241" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/device/tagStream.md b/docs/api/device/tagStream.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L413" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L413" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/timeBetween.md b/docs/api/device/timeBetween.md
@@ -18,7 +18,7 @@
     <span class="token keyword">const</span> <a href="#/api/streamTag/">occa::streamTag</a> &amp;endTag
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L436" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L436" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/device/waitFor.md b/docs/api/device/waitFor.md
@@ -16,7 +16,7 @@
     <a href="#/api/streamTag/">occa::streamTag</a> tag
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L423" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L423" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/device/wrapMemory.md b/docs/api/device/wrapMemory.md
@@ -22,7 +22,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L685" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L657" target="_blank">Source</a>
     </div>
     <div class="description">
 
@@ -52,7 +52,7 @@
     <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L697" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/core/device.hpp#L669" target="_blank">Source</a>
     </div>
     <div class="description">
 

diff --git a/docs/api/dtype_t/addField.md b/docs/api/dtype_t/addField.md
@@ -20,7 +20,7 @@
     <span class="token keyword">const</span> <span class="token keyword">int</span> tupleSize&#95;
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/dtype/dtype.hpp#L184" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/dtype/dtype.hpp#L184" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/dtype_t/bytes.md b/docs/api/dtype_t/bytes.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/dtype/dtype.hpp#L86" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/dtype/dtype.hpp#L86" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/dtype_t/canBeCastedTo.md b/docs/api/dtype_t/canBeCastedTo.md
@@ -16,7 +16,7 @@
     <span class="token keyword">const</span> <a href="#/api/dtype_t/">occa::dtype&#95;t</a> &amp;other
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/dtype/dtype.hpp#L236" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/dtype/dtype.hpp#L236" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/dtype_t/isStruct.md b/docs/api/dtype_t/isStruct.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/dtype/dtype.hpp#L134" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/dtype/dtype.hpp#L134" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/dtype_t/isTuple.md b/docs/api/dtype_t/isTuple.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/dtype/dtype.hpp#L112" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/dtype/dtype.hpp#L112" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/dtype_t/matches.md b/docs/api/dtype_t/matches.md
@@ -16,7 +16,7 @@
     <span class="token keyword">const</span> <a href="#/api/dtype_t/">occa::dtype&#95;t</a> &amp;other
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/dtype/dtype.hpp#L222" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/dtype/dtype.hpp#L222" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/dtype_t/name.md b/docs/api/dtype_t/name.md
@@ -16,7 +16,7 @@
 
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/dtype/dtype.hpp#L76" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/dtype/dtype.hpp#L76" target="_blank">Source</a>
     </div>
 
   </div>

diff --git a/docs/api/dtype_t/operator_bracket.md b/docs/api/dtype_t/operator_bracket.md
@@ -16,7 +16,7 @@
     <span class="token keyword">const</span> <span class="token keyword">int</span> field
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/dtype/dtype.hpp#L164" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/dtype/dtype.hpp#L164" target="_blank">Source</a>
     </div>
 
   </div>
@@ -28,7 +28,7 @@
     <span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;field
 )</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/dtype/dtype.hpp#L174" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/7d02eac1/include/occa/dtype/dtype.hpp#L174" target="_blank">Source</a>
     </div>
 
   </div>