Commit 4a592d95 authored by Greg Williams's avatar Greg Williams
Browse files

Removed Doxygen docs/ generation folder from kinetic-c main and added to... 

Removed Doxygen docs/ generation folder from kinetic-c main and added to .gitignore, since will be published to gh-pages branch, yet allow local generation into ignored folder.
parent 4424dcf4

.gitignore

+1 −0
Original line number Diff line number Diff line
@@ -28,6 +28,7 @@ 
# Temp folders

bin/

build/

docs/



# Other local files to ignore

.tags*

Rakefile

+26 −8
Original line number Diff line number Diff line
@@ -81,14 +81,32 @@ task :cppcheck do 
  execute_command "cppcheck ./src ./build/temp/proto", "Analyzing code w/CppCheck"

end



namespace :doxygen do



  DOCS_PATH = "./docs/"

  directory DOCS_PATH

  CLOBBER.include DOCS_PATH



  task :checkout_github_pages => ['clobber', DOCS_PATH] do

    git "clone git@github.com:atomicobject/kinetic-c.git -b gh-pages #{DOCS_PATH}"

    cd DOCS_PATH do

      git "rm -r docs/"

      cp "../README.md", "."

      cp "../LICENSE", "."

    end

  end



  desc "Generate API docs"

task :doxygen => [DOCS_PATH] do

  task :gen => [DOCS_PATH] do

    report_banner "Generating Doxygen API Docs"

    execute_command "doxygen config/Doxyfile"

  git "add docs/"

  end



  task :gen_github_pages => ['doxygen:checkout_github_pages', 'doxygen:gen'] do

    git "add --all"

    git "status"

  end



end



namespace :test_server do

docs/_doxygen_main_page_8md_source.html

deleted100644 → 0
+0 −112
Original line number Diff line number Diff line 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<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>Kinetic C Client: config/DoxygenMainPage.md 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>

<link href="search/search.css" rel="stylesheet" type="text/css"/>

<script type="text/javascript" src="search/search.js"></script>

<script type="text/javascript">

  $(document).ready(function() { searchBox.OnSelectItem(0); });

</script>

<link href="doxygen.css" rel="stylesheet" type="text/css" />

</head>

<body>

<div id="top"><!-- do not remove this div, it is closed by doxygen! -->

<div id="titlearea">

<table cellspacing="0" cellpadding="0">

 <tbody>

 <tr style="height: 56px;">

  <td style="padding-left: 0.5em;">

   <div id="projectname">Kinetic C Client

   </div>

  </td>

 </tr>

 </tbody>

</table>

</div>

<!-- end header part -->

<!-- Generated by Doxygen 1.8.6 -->

<script type="text/javascript">

var searchBox = new SearchBox("searchBox", "search",false,'Search');

</script>

  <div id="navrow1" class="tabs">

    <ul class="tablist">

      <li><a href="index.html"><span>Main&#160;Page</span></a></li>

      <li><a href="annotated.html"><span>Classes</span></a></li>

      <li class="current"><a href="files.html"><span>Files</span></a></li>

      <li>

        <div id="MSearchBox" class="MSearchBoxInactive">

        <span class="left">

          <img id="MSearchSelect" src="search/mag_sel.png"

               onmouseover="return searchBox.OnSearchSelectShow()"

               onmouseout="return searchBox.OnSearchSelectHide()"

               alt=""/>

          <input type="text" id="MSearchField" value="Search" accesskey="S"

               onfocus="searchBox.OnSearchFieldFocus(true)" 

               onblur="searchBox.OnSearchFieldFocus(false)" 

               onkeyup="searchBox.OnSearchFieldChange(event)"/>

          </span><span class="right">

            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

          </span>

        </div>

      </li>

    </ul>

  </div>

  <div id="navrow2" class="tabs2">

    <ul class="tablist">

      <li><a href="files.html"><span>File&#160;List</span></a></li>

    </ul>

  </div>

</div><!-- top -->

<!-- window showing the filter options -->

<div id="MSearchSelectWindow"

     onmouseover="return searchBox.OnSearchSelectShow()"

     onmouseout="return searchBox.OnSearchSelectHide()"

     onkeydown="return searchBox.OnSearchSelectKey(event)">

<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a></div>



<!-- iframe showing the search results (closed by default) -->

<div id="MSearchResultsWindow">

<iframe src="javascript:void(0)" frameborder="0" 

        name="MSearchResults" id="MSearchResults">

</iframe>

</div>



<div class="header">

  <div class="headertitle">

<div class="title">config/DoxygenMainPage.md</div>  </div>

</div><!--header-->

<div class="contents">

<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;Quickstart {#mainpage}</div>

<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;======================</div>

<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;This library allows building C programs that interact with a Kinetic API implementation. It provides blocking and non-blocking styles of interaction depending on application needs.</div>

<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div>

<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;Including the library</div>

<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;---------------------</div>

<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;TBD</div>

<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div>

<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;Opening a connection</div>

<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;--------------------</div>

<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;TBD</div>

<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>

<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;Performing blocking GET/PUT operations</div>

<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;--------------------------------------</div>

<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;TBD</div>

<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>

<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;Performing non-blocking GET/PUT operations</div>

<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;------------------------------------------</div>

<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;TBD</div>

</div><!-- fragment --></div><!-- contents -->

<!-- start footer part -->

<hr class="footer"/><address class="footer"><small>

Generated on Mon Jul 14 2014 10:16:08 for Kinetic C Client by &#160;<a href="http://www.doxygen.org/index.html">

<img class="footer" src="doxygen.png" alt="doxygen"/>

</a> 1.8.6

</small></address>

</body>

</html>

docs/_kinetic_api_8c_source.html

deleted100644 → 0
+0 −132
Original line number Diff line number Diff line 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<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>Kinetic C Client: src/lib/KineticApi.c 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>

<link href="search/search.css" rel="stylesheet" type="text/css"/>

<script type="text/javascript" src="search/search.js"></script>

<script type="text/javascript">

  $(document).ready(function() { searchBox.OnSelectItem(0); });

</script>

<link href="doxygen.css" rel="stylesheet" type="text/css" />

</head>

<body>

<div id="top"><!-- do not remove this div, it is closed by doxygen! -->

<div id="titlearea">

<table cellspacing="0" cellpadding="0">

 <tbody>

 <tr style="height: 56px;">

  <td style="padding-left: 0.5em;">

   <div id="projectname">Kinetic C Client

   </div>

  </td>

 </tr>

 </tbody>

</table>

</div>

<!-- end header part -->

<!-- Generated by Doxygen 1.8.6 -->

<script type="text/javascript">

var searchBox = new SearchBox("searchBox", "search",false,'Search');

</script>

  <div id="navrow1" class="tabs">

    <ul class="tablist">

      <li><a href="index.html"><span>Main&#160;Page</span></a></li>

      <li><a href="annotated.html"><span>Classes</span></a></li>

      <li class="current"><a href="files.html"><span>Files</span></a></li>

      <li>

        <div id="MSearchBox" class="MSearchBoxInactive">

        <span class="left">

          <img id="MSearchSelect" src="search/mag_sel.png"

               onmouseover="return searchBox.OnSearchSelectShow()"

               onmouseout="return searchBox.OnSearchSelectHide()"

               alt=""/>

          <input type="text" id="MSearchField" value="Search" accesskey="S"

               onfocus="searchBox.OnSearchFieldFocus(true)" 

               onblur="searchBox.OnSearchFieldFocus(false)" 

               onkeyup="searchBox.OnSearchFieldChange(event)"/>

          </span><span class="right">

            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

          </span>

        </div>

      </li>

    </ul>

  </div>

  <div id="navrow2" class="tabs2">

    <ul class="tablist">

      <li><a href="files.html"><span>File&#160;List</span></a></li>

    </ul>

  </div>

<!-- window showing the filter options -->

<div id="MSearchSelectWindow"

     onmouseover="return searchBox.OnSearchSelectShow()"

     onmouseout="return searchBox.OnSearchSelectHide()"

     onkeydown="return searchBox.OnSearchSelectKey(event)">

<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a></div>



<!-- iframe showing the search results (closed by default) -->

<div id="MSearchResultsWindow">

<iframe src="javascript:void(0)" frameborder="0" 

        name="MSearchResults" id="MSearchResults">

</iframe>

</div>



<div id="nav-path" class="navpath">

  <ul>

<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_c85d3e3c5052e9ad9ce18c6863244a25.html">lib</a></li>  </ul>

</div>

</div><!-- top -->

<div class="header">

  <div class="headertitle">

<div class="title">KineticApi.c</div>  </div>

</div><!--header-->

<div class="contents">

<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#include &quot;KineticApi.h&quot;</span></div>

<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#include &quot;KineticConnection.h&quot;</span></div>

<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#include &quot;KineticLogger.h&quot;</span></div>

<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &lt;stdio.h&gt;</span></div>

<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;</div>

<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="keywordtype">void</span> KineticApi_Init(<span class="keyword">const</span> <span class="keywordtype">char</span>* log_file)</div>

<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;{</div>

<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;    KineticLogger_Init(log_file);</div>

<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;}</div>

<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div>

<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="keyword">const</span> <a class="code" href="struct___kinetic_connection.html">KineticConnection</a> KineticApi_Connect(<span class="keyword">const</span> <span class="keywordtype">char</span>* host, <span class="keywordtype">int</span> port, <span class="keywordtype">bool</span> blocking)</div>

<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;{</div>

<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;    <a class="code" href="struct___kinetic_connection.html">KineticConnection</a> connection = KineticConnection_Create();</div>

<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div>

<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;    <span class="keywordflow">if</span> (!KineticConnection_Connect(&amp;connection, host, port, blocking))</div>

<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;    {</div>

<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;        connection.Connected = <span class="keyword">false</span>;</div>

<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;        connection.FileDescriptor = -1;</div>

<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;        <span class="keywordtype">char</span> message[64];</div>

<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;        sprintf(message, <span class="stringliteral">&quot;Failed creating connection to %s:%d&quot;</span>, host, port);</div>

<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;        LOG(message);</div>

<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    }</div>

<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    <span class="keywordflow">else</span></div>

<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    {</div>

<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;        connection.Connected = <span class="keyword">true</span>;</div>

<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    }</div>

<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>

<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <span class="keywordflow">return</span> connection;</div>

<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;}</div>

<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>

<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;KineticProto_Status_StatusCode KineticApi_SendNoop(<span class="keyword">const</span> <a class="code" href="struct___kinetic_connection.html">KineticConnection</a>* connection)</div>

<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;{</div>

<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    <span class="keywordflow">return</span> KINETIC_PROTO_STATUS_STATUS_CODE_INVALID_STATUS_CODE;</div>

<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;}</div>

<div class="ttc" id="struct___kinetic_connection_html"><div class="ttname"><a href="struct___kinetic_connection.html">_KineticConnection</a></div><div class="ttdef"><b>Definition:</b> <a href="_kinetic_types_8h_source.html#l00040">KineticTypes.h:40</a></div></div>

</div><!-- fragment --></div><!-- contents -->

<!-- start footer part -->

<hr class="footer"/><address class="footer"><small>

Generated on Mon Jul 14 2014 10:16:08 for Kinetic C Client by &#160;<a href="http://www.doxygen.org/index.html">

<img class="footer" src="doxygen.png" alt="doxygen"/>

</a> 1.8.6

</small></address>

</body>

</html>

docs/_kinetic_api_8h_source.html

deleted100644 → 0
+0 −108
Original line number Diff line number Diff line 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<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>Kinetic C Client: src/lib/KineticApi.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>

<link href="search/search.css" rel="stylesheet" type="text/css"/>

<script type="text/javascript" src="search/search.js"></script>

<script type="text/javascript">

  $(document).ready(function() { searchBox.OnSelectItem(0); });

</script>

<link href="doxygen.css" rel="stylesheet" type="text/css" />

</head>

<body>

<div id="top"><!-- do not remove this div, it is closed by doxygen! -->

<div id="titlearea">

<table cellspacing="0" cellpadding="0">

 <tbody>

 <tr style="height: 56px;">

  <td style="padding-left: 0.5em;">

   <div id="projectname">Kinetic C Client

   </div>

  </td>

 </tr>

 </tbody>

</table>

</div>

<!-- end header part -->

<!-- Generated by Doxygen 1.8.6 -->

<script type="text/javascript">

var searchBox = new SearchBox("searchBox", "search",false,'Search');

</script>

  <div id="navrow1" class="tabs">

    <ul class="tablist">

      <li><a href="index.html"><span>Main&#160;Page</span></a></li>

      <li><a href="annotated.html"><span>Classes</span></a></li>

      <li class="current"><a href="files.html"><span>Files</span></a></li>

      <li>

        <div id="MSearchBox" class="MSearchBoxInactive">

        <span class="left">

          <img id="MSearchSelect" src="search/mag_sel.png"

               onmouseover="return searchBox.OnSearchSelectShow()"

               onmouseout="return searchBox.OnSearchSelectHide()"

               alt=""/>

          <input type="text" id="MSearchField" value="Search" accesskey="S"

               onfocus="searchBox.OnSearchFieldFocus(true)" 

               onblur="searchBox.OnSearchFieldFocus(false)" 

               onkeyup="searchBox.OnSearchFieldChange(event)"/>

          </span><span class="right">

            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

          </span>

        </div>

      </li>

    </ul>

  </div>

  <div id="navrow2" class="tabs2">

    <ul class="tablist">

      <li><a href="files.html"><span>File&#160;List</span></a></li>

    </ul>

  </div>

<!-- window showing the filter options -->

<div id="MSearchSelectWindow"

     onmouseover="return searchBox.OnSearchSelectShow()"

     onmouseout="return searchBox.OnSearchSelectHide()"

     onkeydown="return searchBox.OnSearchSelectKey(event)">

<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a></div>



<!-- iframe showing the search results (closed by default) -->

<div id="MSearchResultsWindow">

<iframe src="javascript:void(0)" frameborder="0" 

        name="MSearchResults" id="MSearchResults">

</iframe>

</div>



<div id="nav-path" class="navpath">

  <ul>

<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_c85d3e3c5052e9ad9ce18c6863244a25.html">lib</a></li>  </ul>

</div>

</div><!-- top -->

<div class="header">

  <div class="headertitle">

<div class="title">KineticApi.h</div>  </div>

</div><!--header-->

<div class="contents">

<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef _KINETIC_API_H</span></div>

<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _KINETIC_API_H</span></div>

<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor"></span></div>

<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &quot;KineticTypes.h&quot;</span></div>

<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;</div>

<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="keywordtype">void</span> KineticApi_Init(<span class="keyword">const</span> <span class="keywordtype">char</span>* log_file);</div>

<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="keyword">const</span> <a class="code" href="struct___kinetic_connection.html">KineticConnection</a> KineticApi_Connect(<span class="keyword">const</span> <span class="keywordtype">char</span>* host, <span class="keywordtype">int</span> port, <span class="keywordtype">bool</span> blocking);</div>

<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;KineticProto_Status_StatusCode KineticApi_SendNoop(<span class="keyword">const</span> <a class="code" href="struct___kinetic_connection.html">KineticConnection</a>* connection);</div>

<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div>

<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#endif // _KINETIC_API_H</span></div>

<div class="ttc" id="struct___kinetic_connection_html"><div class="ttname"><a href="struct___kinetic_connection.html">_KineticConnection</a></div><div class="ttdef"><b>Definition:</b> <a href="_kinetic_types_8h_source.html#l00040">KineticTypes.h:40</a></div></div>

</div><!-- fragment --></div><!-- contents -->

<!-- start footer part -->

<hr class="footer"/><address class="footer"><small>

Generated on Mon Jul 14 2014 10:16:08 for Kinetic C Client by &#160;<a href="http://www.doxygen.org/index.html">

<img class="footer" src="doxygen.png" alt="doxygen"/>

</a> 1.8.6

</small></address>

</body>

</html>