[Docs] Finish API documentation (libocca#482)

docs/api/README.md

@@ -1,7 +1,5 @@
 # API
 
-?> API documentation is still under development
-
 Welcome to the OCCA library API documentation!
 
 

docs/api/_sidebar.md

@@ -8,13 +8,13 @@
 </div>
 
 - [**API**](/api/)
+  - [occa::device](/api/device/)
+  - [occa::dtype_t](/api/dtype_t/)
+  - [occa::function](/api/function/)
+  - [occa::hash_t](/api/hash_t/)
   - [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)
-  - [occa::stream](/api/stream)
-  - [occa::dtype_t](/api/dtype_t)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::memory](/api/memory/)
-  - [occa::streamTag](/api/streamTag)
+  - [occa::stream](/api/stream/)
+  - [occa::streamTag](/api/streamTag/)

docs/api/device/README.md

@@ -37,7 +37,7 @@ JSON formatted strings can also be passed directly, which can be useful when loa
 
 ```cpp
 occa::device device(
-  "{ mode: 'CUDA", device_id: 0 }"
+  "{ mode: 'CUDA', device_id: 0 }"
 );
 ```
 

docs/api/device/_sidebar.md

@@ -8,10 +8,6 @@
 </div>
 
 - [**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)
     - [buildKernel](/api/device/buildKernel)
@@ -36,8 +32,12 @@
     - [timeBetween](/api/device/timeBetween)
     - [waitFor](/api/device/waitFor)
     - [wrapMemory](/api/device/wrapMemory)
-  - [occa::function](/api/function)
-  - [occa::stream](/api/stream)
-  - [occa::dtype_t](/api/dtype_t)
+  - [occa::dtype_t](/api/dtype_t/)
+  - [occa::function](/api/function/)
+  - [occa::hash_t](/api/hash_t/)
+  - [occa::json](/api/json/)
+  - [occa::kernel](/api/kernel/)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::memory](/api/memory/)
-  - [occa::streamTag](/api/streamTag)
+  - [occa::stream](/api/stream/)
+  - [occa::streamTag](/api/streamTag/)

docs/api/device/buildKernel.md

@@ -11,11 +11,16 @@
 
   <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>
+      <code class="desktop-only"><a href="#/api/kernel/">occa::kernel</a> buildKernel(<span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;filename,
+                         <span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;kernelName,
+                         <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props)</code>
+      <code class="mobile-only"><a href="#/api/kernel/">occa::kernel</a> buildKernel(
+    <span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;filename,
+    <span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;kernelName,
+    <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/7d325d3f/include/occa/core/device.hpp#L511" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L513" target="_blank">Source</a>
     </div>
     <div class="description">
 
@@ -104,7 +109,7 @@ props["headers"] += "#define TWO 2";
   </a>
 </h3>
 
-Lastly, [occa::function](/api/function)'s can be captured through the `functions` path.
+Lastly, [occa::function](/api/function/)'s can be captured through the `functions` path.
 For example:
 
 ```cpp

docs/api/device/buildKernel/_sidebar.md

@@ -8,18 +8,18 @@
 </div>
 
 - [**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)
     - [buildKernel](/api/device/buildKernel)
-  - [occa::function](/api/function)
-  - [occa::stream](/api/stream)
-  - [occa::dtype_t](/api/dtype_t)
+  - [occa::dtype_t](/api/dtype_t/)
+  - [occa::function](/api/function/)
+  - [occa::hash_t](/api/hash_t/)
+  - [occa::json](/api/json/)
+  - [occa::kernel](/api/kernel/)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::memory](/api/memory/)
-  - [occa::streamTag](/api/streamTag)
+  - [occa::stream](/api/stream/)
+  - [occa::streamTag](/api/streamTag/)
     - [buildKernelFromString](/api/device/buildKernelFromString)
     - [createStream](/api/device/createStream)
     - [dontUseRefs](/api/device/dontUseRefs)

docs/api/device/buildKernelFromString.md

@@ -11,11 +11,16 @@
 
   <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>
+      <code class="desktop-only"><a href="#/api/kernel/">occa::kernel</a> buildKernelFromString(<span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;content,
+                                   <span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;kernelName,
+                                   <span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props)</code>
+      <code class="mobile-only"><a href="#/api/kernel/">occa::kernel</a> buildKernelFromString(
+    <span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;content,
+    <span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;kernelName,
+    <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/7d325d3f/include/occa/core/device.hpp#L535" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L537" target="_blank">Source</a>
     </div>
     <div class="description">
 

docs/api/device/buildKernelFromString/_sidebar.md

@@ -8,19 +8,19 @@
 </div>
 
 - [**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)
     - [buildKernel](/api/device/buildKernel)
     - [buildKernelFromString](/api/device/buildKernelFromString)
-  - [occa::function](/api/function)
-  - [occa::stream](/api/stream)
-  - [occa::dtype_t](/api/dtype_t)
+  - [occa::dtype_t](/api/dtype_t/)
+  - [occa::function](/api/function/)
+  - [occa::hash_t](/api/hash_t/)
+  - [occa::json](/api/json/)
+  - [occa::kernel](/api/kernel/)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::memory](/api/memory/)
-  - [occa::streamTag](/api/streamTag)
+  - [occa::stream](/api/stream/)
+  - [occa::streamTag](/api/streamTag/)
     - [createStream](/api/device/createStream)
     - [dontUseRefs](/api/device/dontUseRefs)
     - [finish](/api/device/finish)

docs/api/device/constructor.md

@@ -11,9 +11,12 @@
 
   <div class="definition-container">
     <div class="definition">
-      <code>device()</code>
+      <code class="desktop-only">device()</code>
+      <code class="mobile-only">device(
+
+)</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/7d325d3f/include/occa/core/device.hpp#L130" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L130" target="_blank">Source</a>
     </div>
     <div class="description">
 
@@ -27,9 +30,12 @@
 
   <div class="definition-container">
     <div class="definition">
-      <code>device(<span class="token keyword">const</span> <span class="token keyword">std::string</span> &props)</code>
+      <code class="desktop-only">device(<span class="token keyword">const</span> <span class="token keyword">std::string</span> &amp;props)</code>
+      <code class="mobile-only">device(
+    <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/7d325d3f/include/occa/core/device.hpp#L144" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L144" target="_blank">Source</a>
     </div>
     <div class="description">
 
@@ -52,9 +58,12 @@
 
   <div class="definition-container">
     <div class="definition">
-      <code>device(<span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &props)</code>
+      <code class="desktop-only">device(<span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props)</code>
+      <code class="mobile-only">device(
+    <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/7d325d3f/include/occa/core/device.hpp#L158" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L158" target="_blank">Source</a>
     </div>
     <div class="description">
 

docs/api/device/constructor/_sidebar.md

@@ -8,17 +8,17 @@
 </div>
 
 - [**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)
-  - [occa::function](/api/function)
-  - [occa::stream](/api/stream)
-  - [occa::dtype_t](/api/dtype_t)
+  - [occa::dtype_t](/api/dtype_t/)
+  - [occa::function](/api/function/)
+  - [occa::hash_t](/api/hash_t/)
+  - [occa::json](/api/json/)
+  - [occa::kernel](/api/kernel/)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::memory](/api/memory/)
-  - [occa::streamTag](/api/streamTag)
+  - [occa::stream](/api/stream/)
+  - [occa::streamTag](/api/streamTag/)
     - [buildKernel](/api/device/buildKernel)
     - [buildKernelFromString](/api/device/buildKernelFromString)
     - [createStream](/api/device/createStream)

docs/api/device/createStream.md

@@ -11,15 +11,18 @@
 
   <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>
+      <code class="desktop-only"><a href="#/api/stream/">occa::stream</a> createStream(<span class="token keyword">const</span> <a href="#/api/json/">occa::json</a> &amp;props)</code>
+      <code class="mobile-only"><a href="#/api/stream/">occa::stream</a> createStream(
+    <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/7d325d3f/include/occa/core/device.hpp#L375" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L377" 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>
@@ -34,7 +37,7 @@
   </a>
 </h2>
 
-Creates and returns a new [occa::stream](/api/stream) to queue operations on.
+Creates and returns a new [occa::stream](/api/stream/) to queue operations on.
 If the backend supports streams, out-of-order work can be achieved through
 the use of streams.
 

docs/api/device/createStream/_sidebar.md

@@ -8,20 +8,20 @@
 </div>
 
 - [**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)
     - [buildKernel](/api/device/buildKernel)
     - [buildKernelFromString](/api/device/buildKernelFromString)
     - [createStream](/api/device/createStream)
-  - [occa::function](/api/function)
-  - [occa::stream](/api/stream)
-  - [occa::dtype_t](/api/dtype_t)
+  - [occa::dtype_t](/api/dtype_t/)
+  - [occa::function](/api/function/)
+  - [occa::hash_t](/api/hash_t/)
+  - [occa::json](/api/json/)
+  - [occa::kernel](/api/kernel/)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::memory](/api/memory/)
-  - [occa::streamTag](/api/streamTag)
+  - [occa::stream](/api/stream/)
+  - [occa::streamTag](/api/streamTag/)
     - [dontUseRefs](/api/device/dontUseRefs)
     - [finish](/api/device/finish)
     - [free](/api/device/free)

docs/api/device/dontUseRefs.md

@@ -11,9 +11,12 @@
 
   <div class="definition-container">
     <div class="definition">
-      <code><span class="token keyword">void</span> dontUseRefs()</code>
+      <code class="desktop-only"><span class="token keyword">void</span> dontUseRefs()</code>
+      <code class="mobile-only"><span class="token keyword">void</span> dontUseRefs(
+
+)</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/7d325d3f/include/occa/core/device.hpp#L185" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L185" target="_blank">Source</a>
     </div>
 
   </div>

docs/api/device/dontUseRefs/_sidebar.md

@@ -8,21 +8,21 @@
 </div>
 
 - [**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)
     - [buildKernel](/api/device/buildKernel)
     - [buildKernelFromString](/api/device/buildKernelFromString)
     - [createStream](/api/device/createStream)
     - [dontUseRefs](/api/device/dontUseRefs)
-  - [occa::function](/api/function)
-  - [occa::stream](/api/stream)
-  - [occa::dtype_t](/api/dtype_t)
+  - [occa::dtype_t](/api/dtype_t/)
+  - [occa::function](/api/function/)
+  - [occa::hash_t](/api/hash_t/)
+  - [occa::json](/api/json/)
+  - [occa::kernel](/api/kernel/)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::memory](/api/memory/)
-  - [occa::streamTag](/api/streamTag)
+  - [occa::stream](/api/stream/)
+  - [occa::streamTag](/api/streamTag/)
     - [finish](/api/device/finish)
     - [free](/api/device/free)
     - [getStream](/api/device/getStream)

docs/api/device/finish.md

@@ -11,9 +11,12 @@
 
   <div class="definition-container">
     <div class="definition">
-      <code><span class="token keyword">void</span> finish()</code>
+      <code class="desktop-only"><span class="token keyword">void</span> finish()</code>
+      <code class="mobile-only"><span class="token keyword">void</span> finish(
+
+)</code>
       <div class="flex-spacing"></div>
-      <a href="https://github.com/libocca/occa/blob/7d325d3f/include/occa/core/device.hpp#L341" target="_blank">Source</a>
+      <a href="https://github.com/libocca/occa/blob/6d155d0c/include/occa/core/device.hpp#L343" target="_blank">Source</a>
     </div>
 
   </div>

docs/api/device/finish/_sidebar.md

@@ -8,22 +8,22 @@
 </div>
 
 - [**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)
     - [buildKernel](/api/device/buildKernel)
     - [buildKernelFromString](/api/device/buildKernelFromString)
     - [createStream](/api/device/createStream)
     - [dontUseRefs](/api/device/dontUseRefs)
     - [finish](/api/device/finish)
-  - [occa::function](/api/function)
-  - [occa::stream](/api/stream)
-  - [occa::dtype_t](/api/dtype_t)
+  - [occa::dtype_t](/api/dtype_t/)
+  - [occa::function](/api/function/)
+  - [occa::hash_t](/api/hash_t/)
+  - [occa::json](/api/json/)
+  - [occa::kernel](/api/kernel/)
+  - [occa::kernelArg](/api/kernelArg)
   - [occa::memory](/api/memory/)
-  - [occa::streamTag](/api/streamTag)
+  - [occa::stream](/api/stream/)
+  - [occa::streamTag](/api/streamTag/)
     - [free](/api/device/free)
     - [getStream](/api/device/getStream)
     - [hasSeparateMemorySpace](/api/device/hasSeparateMemorySpace)