Update doxygen documentation

This commit is contained in:
Maneesh Gupta
2016-04-19 22:44:58 +05:30
parent 3c7a52971e
commit 9c86c680d9
90 changed files with 338 additions and 343 deletions
@@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>HIP: Heterogenous-computing Interface for Portability: /home/mangupta/hip_git/rel0.84.0/include/hip_runtime_api.h Source File</title>
<title>HIP: Heterogenous-computing Interface for Portability: /home/mangupta/hip_git/release_0.84.00/include/hip_runtime_api.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
@@ -114,7 +114,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &lt;string.h&gt;</span> <span class="comment">// for getDeviceProp</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &lt;hip_common.h&gt;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &lt;hip/hip_common.h&gt;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structhipDeviceArch__t.html"> 35</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="comment">// 32-bit Atomics</span></div>
@@ -263,9 +263,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160;} <a class="code" href="group__GlobalDefs.html#gacc0acd7b9bda126c6bb3dfd6e2796d7c">hipDeviceAttribute_t</a>;</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;<span class="preprocessor">#if defined(__HIP_PLATFORM_HCC__) &amp;&amp; !defined (__HIP_PLATFORM_NVCC__)</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="hcc__detail_2hip__runtime__api_8h.html">hcc_detail/hip_runtime_api.h</a>&quot;</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &quot;hip/hcc_detail/hip_runtime_api.h&quot;</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;<span class="preprocessor">#elif defined(__HIP_PLATFORM_NVCC__) &amp;&amp; !defined (__HIP_PLATFORM_HCC__)</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &quot;nvcc_detail/hip_runtime_api.h&quot;</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &quot;hip/nvcc_detail/hip_runtime_api.h&quot;</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#error(&quot;Must define exactly one of __HIP_PLATFORM_HCC__ or __HIP_PLATFORM_NVCC__&quot;);</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
@@ -359,7 +359,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="ttc" id="structhipDeviceProp__t_html_ae6aa845dc2d540f85098ea30be35f4eb"><div class="ttname"><a href="structhipDeviceProp__t.html#ae6aa845dc2d540f85098ea30be35f4eb">hipDeviceProp_t::pciDeviceID</a></div><div class="ttdeci">int pciDeviceID</div><div class="ttdoc">PCI Device ID. </div><div class="ttdef"><b>Definition:</b> hip_runtime_api.h:97</div></div>
<div class="ttc" id="structhipDeviceProp__t_html_a5b44bf8fa46faefcde989942b1d11a5e"><div class="ttname"><a href="structhipDeviceProp__t.html#a5b44bf8fa46faefcde989942b1d11a5e">hipDeviceProp_t::name</a></div><div class="ttdeci">char name[256]</div><div class="ttdoc">Device name. </div><div class="ttdef"><b>Definition:</b> hip_runtime_api.h:75</div></div>
<div class="ttc" id="structhipDeviceArch__t_html"><div class="ttname"><a href="structhipDeviceArch__t.html">hipDeviceArch_t</a></div><div class="ttdef"><b>Definition:</b> hip_runtime_api.h:35</div></div>
<div class="ttc" id="hcc__detail_2hip__runtime__api_8h_html"><div class="ttname"><a href="hcc__detail_2hip__runtime__api_8h.html">hip_runtime_api.h</a></div><div class="ttdoc">Contains C function APIs for HIP runtime. This file does not use any HCC builtin or special language ...</div></div>
<div class="ttc" id="structhipDeviceProp__t_html_a6db0ab8e7e8cc13c84d7bb7f70226d5e"><div class="ttname"><a href="structhipDeviceProp__t.html#a6db0ab8e7e8cc13c84d7bb7f70226d5e">hipDeviceProp_t::memoryClockRate</a></div><div class="ttdeci">int memoryClockRate</div><div class="ttdoc">Max global memory clock frequency in khz. </div><div class="ttdef"><b>Definition:</b> hip_runtime_api.h:84</div></div>
<div class="ttc" id="group__GlobalDefs_html_ggadf5010f6e140a53ecbdf949e73e87594a7e935ae88ee1f9ff3920156ac6864520"><div class="ttname"><a href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594a7e935ae88ee1f9ff3920156ac6864520">hipErrorInitializationError</a></div><div class="ttdoc">TODO comment from hipErrorInitializationError. </div><div class="ttdef"><b>Definition:</b> hip_runtime_api.h:153</div></div>
<div class="ttc" id="group__GlobalDefs_html_ggacc0acd7b9bda126c6bb3dfd6e2796d7cad9f45254d0d048677f560032532d5504"><div class="ttname"><a href="group__GlobalDefs.html#ggacc0acd7b9bda126c6bb3dfd6e2796d7cad9f45254d0d048677f560032532d5504">hipDeviceAttributeConcurrentKernels</a></div><div class="ttdoc">Device can possibly execute multiple kernels concurrently. </div><div class="ttdef"><b>Definition:</b> hip_runtime_api.h:191</div></div>
@@ -367,7 +366,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Apr 16 2016 14:52:10 for HIP: Heterogenous-computing Interface for Portability by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Tue Apr 19 2016 22:44:02 for HIP: Heterogenous-computing Interface for Portability by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>