Commit 4424dcf4 authored by Greg Williams's avatar Greg Williams
Browse files

Added doxygen API doc generation and added docs to the repo for git-based... 

Added doxygen API doc generation and added docs to the repo for git-based browsing w/o having to generate them locally
parent 699ab806

.gitignore

+7 −0
Original line number Diff line number Diff line
@@ -22,6 +22,13 @@ 
*.x86_64

*.hex



# Logfiles

*.log



# Temp folders

bin/

build/



# Other local files to ignore

.tags*

*.sublime-workspace

Rakefile

+21 −0
Original line number Diff line number Diff line
@@ -22,6 +22,17 @@ def execute_command(cmd, banner=nil) 
  report unless banner.nil?

end



def git(cmd)

  safe_system("git " + cmd)

end



def safe_system(cmd)

  if !system(cmd)

    puts "Failed: #{cmd}"

    exit

  end

end



HERE = File.expand_path(File.dirname(__FILE__))

VENDOR_PATH = File.join(HERE, 'vendor')

PROTOBUF_CORE = File.join(VENDOR_PATH, 'protobuf-2.5.0')
@@ -70,6 +81,16 @@ task :cppcheck do 
  execute_command "cppcheck ./src ./build/temp/proto", "Analyzing code w/CppCheck"

end



DOCS_PATH = "./docs/"

directory DOCS_PATH

CLOBBER.include DOCS_PATH

desc "Generate API docs"

task :doxygen => [DOCS_PATH] do

  report_banner "Generating Doxygen API Docs"

  execute_command "doxygen config/Doxyfile"

  git "add docs/"

end



namespace :test_server do



  require "webrick"

config/Doxyfile

+4 −4
Original line number Diff line number Diff line
@@ -733,7 +733,7 @@ WARN_LOGFILE = doxygen_warnings.log 
# spaces.

# Note: If this tag is empty the current directory is searched.



INPUT                  = ./src ./include DoxygenMainPage.md

INPUT                  = ./src/lib ./src/utility ./include ./config/DoxygenMainPage.md



# This tag can be used to specify the character encoding of the source files

# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -753,7 +753,7 @@ INPUT_ENCODING = UTF-8 
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,

# *.qsf, *.as and *.js.



FILE_PATTERNS          = *.md *.c *.h *.cc

FILE_PATTERNS          = *.md *.c *.h



# The RECURSIVE tag can be used to specify whether or not subdirectories should

# be searched for input files as well.
@@ -784,7 +784,7 @@ EXCLUDE_SYMLINKS = NO 
# Note that the wildcards are matched against the file with absolute path, so to

# exclude all test directories for example use the pattern */test/*



EXCLUDE_PATTERNS       = *.pb.* *_test.cc *_test.h *mock*

EXCLUDE_PATTERNS       = *.pb.*



# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -869,7 +869,7 @@ FILTER_SOURCE_PATTERNS = 
# (index.html). This can be useful if you have a project on for instance GitHub

# and want to reuse the introduction page also for the doxygen output.



USE_MDFILE_AS_MAINPAGE = D./oxygenMainPage.md

USE_MDFILE_AS_MAINPAGE = ./config/DoxygenMainPage.md



#---------------------------------------------------------------------------

# Configuration options related to source browsing

docs/_doxygen_main_page_8md_source.html

0 → 100644
+112 −0
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

0 → 100644
+132 −0
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>