[Docs] Cleans up operator function signatures (#480)

libocca · Jan 29, 2021 · ea393c1 · ea393c1
1 parent 1202d27
commit ea393c1
Show file tree

Hide file tree

Showing 123 changed files with 461 additions and 403 deletions.
diff --git a/.doxygen b/.doxygen
@@ -31,7 +31,7 @@ ALIASES += rawXmlEnd="]]>"
 ALIASES += startDoc{1}="\xmlonly <occa-doc id=\"\1\">@rawXmlStart "
 ALIASES += endDoc=" @rawXmlEnd</occa-doc> \endxmlonly"
 
-ALIASES += doc="\xmlonly <occa-doc id=\"\1\"></occa-doc> \endxmlonly"
+ALIASES += doc{1}="\xmlonly <occa-doc id=\"\1\"></occa-doc> \endxmlonly"
 #=======================================
 
 

diff --git a/docs/api/_sidebar.md b/docs/api/_sidebar.md
@@ -10,6 +10,7 @@
 - [**API**](/api/)
   - [occa::json](/api/json/)
   - [occa::hash_t](/api/hash_t)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::kernel](/api/kernel/)
   - [occa::device](/api/device/)
   - [occa::function](/api/function)

diff --git a/docs/api/device/_sidebar.md b/docs/api/device/_sidebar.md
@@ -10,6 +10,7 @@
 - [**API**](/api/)
   - [occa::json](/api/json/)
   - [occa::hash_t](/api/hash_t)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::kernel](/api/kernel/)
   - [occa::device](/api/device/)
     - [(constructor)](/api/device/constructor)

diff --git a/docs/api/device/buildKernel.md b/docs/api/device/buildKernel.md
@@ -6,32 +6,26 @@
 </h1>
 
 <div class="signature">
-  <hr>
 
-
+<hr>
+
   <div class="definition-container">
     <div class="definition">
       <code><a href="#/api/kernel/">occa::kernel</a> buildKernel(<span class="token keyword">const</span> <span class="token keyword">std::string</span> &filename,
                          <span class="token keyword">const</span> <span class="token keyword">std::string</span> &kernelName,
                          <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &props)</code>
       <div class="flex-spacing"></div>
-      <a href="/libocca/occa/blob/1fea69a2/include/occa/core/device.hpp#L503" target="_blank">Source</a>
+      <a href="/libocca/occa/blob/6aadf694/include/occa/core/device.hpp#L503" target="_blank">Source</a>
     </div>
     <div class="description">
 
       <div class="section-header">Returns</div>
       <ul class="section-list">
-        <li>
-          ::: markdown
-          The compiled [occa::kernel](/api/kernel/).
-          :::
-        </li>
+        <li> ::: markdown The compiled [occa::kernel](/api/kernel/). ::: </li>
       </ul>
-    </div>
-
+</div>
   </div>
 
-
   <hr>
 </div>
 

diff --git a/docs/api/device/buildKernel/_sidebar.md b/docs/api/device/buildKernel/_sidebar.md
@@ -10,6 +10,7 @@
 - [**API**](/api/)
   - [occa::json](/api/json/)
   - [occa::hash_t](/api/hash_t)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::kernel](/api/kernel/)
   - [occa::device](/api/device/)
     - [(constructor)](/api/device/constructor)

diff --git a/docs/api/device/buildKernelFromString.md b/docs/api/device/buildKernelFromString.md
@@ -6,32 +6,26 @@
 </h1>
 
 <div class="signature">
-  <hr>
 
-
+<hr>
+
   <div class="definition-container">
     <div class="definition">
       <code><a href="#/api/kernel/">occa::kernel</a> buildKernelFromString(<span class="token keyword">const</span> <span class="token keyword">std::string</span> &content,
                                    <span class="token keyword">const</span> <span class="token keyword">std::string</span> &kernelName,
                                    <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &props)</code>
       <div class="flex-spacing"></div>
-      <a href="/libocca/occa/blob/1fea69a2/include/occa/core/device.hpp#L518" target="_blank">Source</a>
+      <a href="/libocca/occa/blob/6aadf694/include/occa/core/device.hpp#L518" target="_blank">Source</a>
     </div>
     <div class="description">
 
       <div class="section-header">Returns</div>
       <ul class="section-list">
-        <li>
-          ::: markdown
-          The compiled [occa::kernel](/api/kernel/).
-          :::
-        </li>
+        <li> ::: markdown The compiled [occa::kernel](/api/kernel/). ::: </li>
       </ul>
-    </div>
-
+</div>
   </div>
 
-
   <hr>
 </div>
 

diff --git a/docs/api/device/buildKernelFromString/_sidebar.md b/docs/api/device/buildKernelFromString/_sidebar.md
@@ -10,6 +10,7 @@
 - [**API**](/api/)
   - [occa::json](/api/json/)
   - [occa::hash_t](/api/hash_t)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::kernel](/api/kernel/)
   - [occa::device](/api/device/)
     - [(constructor)](/api/device/constructor)

diff --git a/docs/api/device/constructor.md b/docs/api/device/constructor.md
@@ -6,84 +6,73 @@
 </h1>
 
 <div class="signature">
-  <hr>
 
-
+<hr>
+
   <div class="definition-container">
     <div class="definition">
-      <code><span class="token keyword"></span> device()</code>
+      <code>device()</code>
       <div class="flex-spacing"></div>
-      <a href="/libocca/occa/blob/1fea69a2/include/occa/core/device.hpp#L130" target="_blank">Source</a>
+      <a href="/libocca/occa/blob/6aadf694/include/occa/core/device.hpp#L130" target="_blank">Source</a>
     </div>
     <div class="description">
 
       <div>
-        ::: markdown
-        Default constructor
-        :::
+        ::: markdown Default constructor :::
       </div>
-
+</div>
   </div>
 
-  <hr>
+<hr>
 
   <div class="definition-container">
     <div class="definition">
-      <code><span class="token keyword"></span> device(<span class="token keyword">const</span> <span class="token keyword">std::string</span> &props)</code>
+      <code>device(<span class="token keyword">const</span> <span class="token keyword">std::string</span> &props)</code>
       <div class="flex-spacing"></div>
-      <a href="/libocca/occa/blob/1fea69a2/include/occa/core/device.hpp#L144" target="_blank">Source</a>
+      <a href="/libocca/occa/blob/6aadf694/include/occa/core/device.hpp#L144" target="_blank">Source</a>
     </div>
     <div class="description">
 
       <div>
-        ::: markdown
-        Takes a JSON-formatted string for the device props.
-        :::
+        ::: markdown Takes a JSON-formatted string for the device props. :::
       </div>
 
       <div class="section-header">Arguments</div>
       <ul class="section-list">
           
         <li>
-          <strong>props</strong>: ::: markdown
-            JSON-formatted string that defines the device properties
-            :::
+          <strong>props</strong>: ::: markdown JSON-formatted string that defines the device properties :::
         </li>
 
       </ul>
-
+</div>
   </div>
 
-  <hr>
+<hr>
 
   <div class="definition-container">
     <div class="definition">
-      <code><span class="token keyword"></span> device(<span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &props)</code>
+      <code>device(<span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &props)</code>
       <div class="flex-spacing"></div>
-      <a href="/libocca/occa/blob/1fea69a2/include/occa/core/device.hpp#L158" target="_blank">Source</a>
+      <a href="/libocca/occa/blob/6aadf694/include/occa/core/device.hpp#L158" target="_blank">Source</a>
     </div>
     <div class="description">
 
       <div>
-        ::: markdown
-        Takes an [occa::json](/api/json/) argument for the device props.
-        :::
+        ::: markdown Takes an [occa::json](/api/json/) argument for the device props. :::
       </div>
 
       <div class="section-header">Arguments</div>
       <ul class="section-list">
           
         <li>
-          <strong>props</strong>: ::: markdown
-            Device properties
-            :::
+          <strong>props</strong>: ::: markdown Device properties :::
         </li>
 
       </ul>
-
+</div>
   </div>
 
-
   <hr>
 </div>
 

diff --git a/docs/api/device/constructor/_sidebar.md b/docs/api/device/constructor/_sidebar.md
@@ -10,6 +10,7 @@
 - [**API**](/api/)
   - [occa::json](/api/json/)
   - [occa::hash_t](/api/hash_t)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::kernel](/api/kernel/)
   - [occa::device](/api/device/)
     - [(constructor)](/api/device/constructor)

diff --git a/docs/api/device/createStream.md b/docs/api/device/createStream.md
@@ -6,30 +6,24 @@
 </h1>
 
 <div class="signature">
-  <hr>
 
-
+<hr>
+
   <div class="definition-container">
     <div class="definition">
       <code><a href="#/api/stream">occa::stream</a> createStream(<span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &props)</code>
       <div class="flex-spacing"></div>
-      <a href="/libocca/occa/blob/1fea69a2/include/occa/core/device.hpp#L375" target="_blank">Source</a>
+      <a href="/libocca/occa/blob/6aadf694/include/occa/core/device.hpp#L375" target="_blank">Source</a>
     </div>
     <div class="description">
 
       <div class="section-header">Returns</div>
       <ul class="section-list">
-        <li>
-          ::: markdown
-          Newly created [occa::stream](/api/stream)
-          :::
-        </li>
+        <li> ::: markdown Newly created [occa::stream](/api/stream) ::: </li>
       </ul>
-    </div>
-
+</div>
   </div>
 
-
   <hr>
 </div>
 

diff --git a/docs/api/device/createStream/_sidebar.md b/docs/api/device/createStream/_sidebar.md
@@ -10,6 +10,7 @@
 - [**API**](/api/)
   - [occa::json](/api/json/)
   - [occa::hash_t](/api/hash_t)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::kernel](/api/kernel/)
   - [occa::device](/api/device/)
     - [(constructor)](/api/device/constructor)

diff --git a/docs/api/device/dontUseRefs.md b/docs/api/device/dontUseRefs.md
@@ -6,19 +6,18 @@
 </h1>
 
 <div class="signature">
-  <hr>
 
-
+<hr>
+
   <div class="definition-container">
     <div class="definition">
       <code><span class="token keyword">void</span> dontUseRefs()</code>
       <div class="flex-spacing"></div>
-      <a href="/libocca/occa/blob/1fea69a2/include/occa/core/device.hpp#L185" target="_blank">Source</a>
+      <a href="/libocca/occa/blob/6aadf694/include/occa/core/device.hpp#L185" target="_blank">Source</a>
     </div>
 
   </div>
 
-
   <hr>
 </div>
 

diff --git a/docs/api/device/dontUseRefs/_sidebar.md b/docs/api/device/dontUseRefs/_sidebar.md
@@ -10,6 +10,7 @@
 - [**API**](/api/)
   - [occa::json](/api/json/)
   - [occa::hash_t](/api/hash_t)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::kernel](/api/kernel/)
   - [occa::device](/api/device/)
     - [(constructor)](/api/device/constructor)

diff --git a/docs/api/device/finish.md b/docs/api/device/finish.md
@@ -6,19 +6,18 @@
 </h1>
 
 <div class="signature">
-  <hr>
 
-
+<hr>
+
   <div class="definition-container">
     <div class="definition">
       <code><span class="token keyword">void</span> finish()</code>
       <div class="flex-spacing"></div>
-      <a href="/libocca/occa/blob/1fea69a2/include/occa/core/device.hpp#L341" target="_blank">Source</a>
+      <a href="/libocca/occa/blob/6aadf694/include/occa/core/device.hpp#L341" target="_blank">Source</a>
     </div>
 
   </div>
 
-
   <hr>
 </div>
 

diff --git a/docs/api/device/finish/_sidebar.md b/docs/api/device/finish/_sidebar.md
@@ -10,6 +10,7 @@
 - [**API**](/api/)
   - [occa::json](/api/json/)
   - [occa::hash_t](/api/hash_t)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::kernel](/api/kernel/)
   - [occa::device](/api/device/)
     - [(constructor)](/api/device/constructor)

diff --git a/docs/api/device/free.md b/docs/api/device/free.md
@@ -6,19 +6,18 @@
 </h1>
 
 <div class="signature">
-  <hr>
 
-
+<hr>
+
   <div class="definition-container">
     <div class="definition">
       <code><span class="token keyword">void</span> free()</code>
       <div class="flex-spacing"></div>
-      <a href="/libocca/occa/blob/1fea69a2/include/occa/core/device.hpp#L254" target="_blank">Source</a>
+      <a href="/libocca/occa/blob/6aadf694/include/occa/core/device.hpp#L254" target="_blank">Source</a>
     </div>
 
   </div>
 
-
   <hr>
 </div>
 

diff --git a/docs/api/device/free/_sidebar.md b/docs/api/device/free/_sidebar.md
@@ -10,6 +10,7 @@
 - [**API**](/api/)
   - [occa::json](/api/json/)
   - [occa::hash_t](/api/hash_t)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::kernel](/api/kernel/)
   - [occa::device](/api/device/)
     - [(constructor)](/api/device/constructor)