Lastest doxygen docs updated
travis build: 29
commit: 03f3b4b230
auto-pushed to gh-pages
This commit is contained in:
@@ -3,44 +3,35 @@
|
||||
<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.7"/>
|
||||
<title>post quantum cryptography: /home/travis/build/hasufell/pqc/src/ntru_string.c File Reference</title>
|
||||
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
<link href="search/search.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! -->
|
||||
|
||||
|
||||
<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">post quantum cryptography
|
||||
|
||||
</div>
|
||||
<div id="projectbrief">Highly optimized implementation of the NTRUEncrypt algorithm</div>
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<!-- Generated by Doxygen 1.7.6.1 -->
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.7 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
@@ -73,56 +64,75 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<li><a href="globals.html"><span>Globals</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</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> </ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">/home/travis/build/hasufell/pqc/src/ntru_string.c File Reference</div> </div>
|
||||
<div class="title">ntru_string.c File Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>string type and operations
|
||||
<a href="#details">More...</a></p>
|
||||
<div class="textblock"><code>#include "<a class="el" href="ntru__string_8h_source.html">ntru_string.h</a>"</code><br/>
|
||||
<code>#include <stdio.h></code><br/>
|
||||
<div class="textblock"><code>#include "<a class="el" href="ntru__string_8h_source.html">ntru_string.h</a>"</code><br />
|
||||
<code>#include <stdio.h></code><br />
|
||||
</div><div class="textblock"><div class="dynheader">
|
||||
Include dependency graph for ntru_string.c:</div>
|
||||
<div class="dyncontent">
|
||||
<div class="center"><img src="ntru__string_8c__incl.png" border="0" usemap="#_2home_2travis_2build_2hasufell_2pqc_2src_2ntru__string_8c" alt=""/></div>
|
||||
<map name="_2home_2travis_2build_2hasufell_2pqc_2src_2ntru__string_8c" id="_2home_2travis_2build_2hasufell_2pqc_2src_2ntru__string_8c">
|
||||
</map>
|
||||
<area shape="rect" id="node3" href="ntru__string_8h.html" title="header for ntru_string.c " alt="" coords="5,117,99,147"/></map>
|
||||
</div>
|
||||
</div>
|
||||
<p><a href="ntru__string_8c_source.html">Go to the source code of this file.</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr><td colspan="2"><h2><a name="func-members"></a>
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__string_8c.html#a55d4ce182c335ff6cca360909a7be395">prints</a> (const <a class="el" href="structstring.html">string</a> *print_string)</td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__string_8c.html#ac1b5f66fbbbdfc7901357ddcfec52e5a">string_delete</a> (<a class="el" href="structstring.html">string</a> *del_string)</td></tr>
|
||||
<tr class="memitem:a55d4ce182c335ff6cca360909a7be395"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__string_8c.html#a55d4ce182c335ff6cca360909a7be395">prints</a> (const <a class="el" href="structstring.html">string</a> *print_string)</td></tr>
|
||||
<tr class="separator:a55d4ce182c335ff6cca360909a7be395"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac1b5f66fbbbdfc7901357ddcfec52e5a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__string_8c.html#ac1b5f66fbbbdfc7901357ddcfec52e5a">string_delete</a> (<a class="el" href="structstring.html">string</a> *del_string)</td></tr>
|
||||
<tr class="separator:ac1b5f66fbbbdfc7901357ddcfec52e5a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>string type and operations </p>
|
||||
<p>Sets up a string type that does not suck like C strings and provides operations on it. </p>
|
||||
|
||||
<p>Definition in file <a class="el" href="ntru__string_8c_source.html">ntru_string.c</a>.</p>
|
||||
</div><hr/><h2>Function Documentation</h2>
|
||||
<a class="anchor" id="a55d4ce182c335ff6cca360909a7be395"></a><!-- doxytag: member="ntru_string.c::prints" ref="a55d4ce182c335ff6cca360909a7be395" args="(const string *print_string)" -->
|
||||
</div><h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="a55d4ce182c335ff6cca360909a7be395"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void <a class="el" href="ntru_8h.html#a55d4ce182c335ff6cca360909a7be395">prints</a> </td>
|
||||
<td class="memname">void prints </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const <a class="el" href="structstring.html">string</a> * </td>
|
||||
<td class="paramname"><em>print_string</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</div><div class="memdoc">
|
||||
<p>Prints the given string to stdout.</p>
|
||||
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">print_string</td><td>the print to string </td></tr>
|
||||
</table>
|
||||
@@ -133,22 +143,21 @@ Functions</h2></td></tr>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ac1b5f66fbbbdfc7901357ddcfec52e5a"></a><!-- doxytag: member="ntru_string.c::string_delete" ref="ac1b5f66fbbbdfc7901357ddcfec52e5a" args="(string *del_string)" -->
|
||||
<a class="anchor" id="ac1b5f66fbbbdfc7901357ddcfec52e5a"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void <a class="el" href="ntru_8h.html#ac1b5f66fbbbdfc7901357ddcfec52e5a">string_delete</a> </td>
|
||||
<td class="memname">void string_delete </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="structstring.html">string</a> * </td>
|
||||
<td class="paramname"><em>del_string</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</div><div class="memdoc">
|
||||
<p>Delete the inner structure of the string and frees the string itself from the heap. Must not be called on stack variables.</p>
|
||||
<dl class="params"><dt><b>Parameters:</b></dt><dd>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">del_string</td><td>the string to delete </td></tr>
|
||||
</table>
|
||||
@@ -160,27 +169,11 @@ Functions</h2></td></tr>
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
<!-- 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Defines</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>
|
||||
|
||||
|
||||
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Sun Jun 8 2014 21:44:13 for post quantum cryptography by  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Sun Jun 8 2014 23:33:23 for post quantum cryptography by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.6.1
|
||||
</a> 1.8.7
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user