Skip to content

Commit 7b2a5c7

Browse files
lucasmcdonald3Lucas McDonald
andauthored
chore: Update docs (#821)
* chore: Update docs * manuall reset version --------- Co-authored-by: Lucas McDonald <lucmcdon@amazon.com>
1 parent 752bc7c commit 7b2a5c7

20 files changed

+587
-583
lines changed

html/cache_8h_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -468,8 +468,8 @@
468468
<div class="ttc" id="agroup__caching_html_gaf298383cea70baeaac20a652aead75a5"><div class="ttname"><a href="group__caching.html#gaf298383cea70baeaac20a652aead75a5">aws_cryptosdk_caching_cmm_set_limit_messages</a></div><div class="ttdeci">int aws_cryptosdk_caching_cmm_set_limit_messages(struct aws_cryptosdk_cmm *cmm, uint64_t limit_messages)</div></div>
469469
<div class="ttc" id="amaterials_8h_html"><div class="ttname"><a href="materials_8h.html">materials.h</a></div></div>
470470
<div class="ttc" id="astructaws__cryptosdk__cmm_html"><div class="ttname"><a href="structaws__cryptosdk__cmm.html">aws_cryptosdk_cmm</a></div><div class="ttdef"><b>Definition</b> <a href="materials_8h_source.html#l00083">materials.h:83</a></div></div>
471-
<div class="ttc" id="astructaws__cryptosdk__dec__materials_html"><div class="ttname"><a href="structaws__cryptosdk__dec__materials.html">aws_cryptosdk_dec_materials</a></div><div class="ttdef"><b>Definition</b> <a href="materials_8h_source.html#l00203">materials.h:203</a></div></div>
472-
<div class="ttc" id="astructaws__cryptosdk__enc__materials_html"><div class="ttname"><a href="structaws__cryptosdk__enc__materials.html">aws_cryptosdk_enc_materials</a></div><div class="ttdef"><b>Definition</b> <a href="materials_8h_source.html#l00173">materials.h:173</a></div></div>
471+
<div class="ttc" id="astructaws__cryptosdk__dec__materials_html"><div class="ttname"><a href="structaws__cryptosdk__dec__materials.html">aws_cryptosdk_dec_materials</a></div><div class="ttdef"><b>Definition</b> <a href="materials_8h_source.html#l00228">materials.h:228</a></div></div>
472+
<div class="ttc" id="astructaws__cryptosdk__enc__materials_html"><div class="ttname"><a href="structaws__cryptosdk__enc__materials.html">aws_cryptosdk_enc_materials</a></div><div class="ttdef"><b>Definition</b> <a href="materials_8h_source.html#l00183">materials.h:183</a></div></div>
473473
<div class="ttc" id="astructaws__cryptosdk__keyring_html"><div class="ttname"><a href="structaws__cryptosdk__keyring.html">aws_cryptosdk_keyring</a></div><div class="ttdef"><b>Definition</b> <a href="materials_8h_source.html#l00096">materials.h:96</a></div></div>
474474
</div><!-- fragment --></div><!-- contents -->
475475
<!-- start footer part -->

html/doxygen_crawl.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@
162162
<a href="group__enc__ctx.html#gac0c62f7ada92e9fc625ffb2d535375da"/>
163163
<a href="group__error.html"/>
164164
<a href="group__error.html#ga05b6450ad4fbdc5c81d7623ebd5c30b8"/>
165-
<a href="group__error.html#ga50773fe0117adb36ff60d1b995418347"/>
165+
<a href="group__error.html#ga8ec3b2a13f0a67d03f74ddeff5e9c23f"/>
166166
<a href="group__error.html#gga05b6450ad4fbdc5c81d7623ebd5c30b8a0f1ae5fd360ca82b3e0f54dda59af910"/>
167167
<a href="group__error.html#gga05b6450ad4fbdc5c81d7623ebd5c30b8a2f8b107210735822f9115fd4b6c70ba7"/>
168168
<a href="group__error.html#gga05b6450ad4fbdc5c81d7623ebd5c30b8a344216c3c19c914723abbc9a80c3b8fa"/>

html/enc__ctx_8h_source.html

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -116,44 +116,44 @@
116116
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
117117
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#endif</span></div>
118118
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span></div>
119-
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span></div>
120-
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>AWS_CRYPTOSDK_API</div>
121-
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="group__enc__ctx.html#gabdbdc0f509405b9f874dda486507ff12"> 48</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="group__enc__ctx.html#gabdbdc0f509405b9f874dda486507ff12">aws_cryptosdk_enc_ctx_init</a>(<span class="keyword">struct</span> aws_allocator *alloc, <span class="keyword">struct</span> aws_hash_table *enc_ctx);</div>
122-
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span></div>
123-
<div class="foldopen" id="foldopen00054" data-start="{" data-end="}">
124-
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="group__enc__ctx.html#ga8211f26569678ab6c27b800744918594"> 54</a></span>AWS_CRYPTOSDK_STATIC_INLINE <span class="keywordtype">void</span> <a class="code hl_function" href="group__enc__ctx.html#ga8211f26569678ab6c27b800744918594">aws_cryptosdk_enc_ctx_clear</a>(<span class="keyword">struct</span> aws_hash_table *enc_ctx) {</div>
125-
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> AWS_PRECONDITION(aws_hash_table_is_valid(enc_ctx));</div>
126-
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> aws_hash_table_clear(enc_ctx);</div>
127-
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> AWS_PRECONDITION(aws_hash_table_is_valid(enc_ctx));</div>
128-
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>}</div>
129-
</div>
119+
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span></div>
120+
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>AWS_CRYPTOSDK_API</div>
121+
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="group__enc__ctx.html#gabdbdc0f509405b9f874dda486507ff12"> 58</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="group__enc__ctx.html#gabdbdc0f509405b9f874dda486507ff12">aws_cryptosdk_enc_ctx_init</a>(<span class="keyword">struct</span> aws_allocator *alloc, <span class="keyword">struct</span> aws_hash_table *enc_ctx);</div>
130122
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span></div>
131123
<div class="foldopen" id="foldopen00064" data-start="{" data-end="}">
132-
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="group__enc__ctx.html#gac0c62f7ada92e9fc625ffb2d535375da"> 64</a></span>AWS_CRYPTOSDK_STATIC_INLINE <span class="keywordtype">void</span> <a class="code hl_function" href="group__enc__ctx.html#gac0c62f7ada92e9fc625ffb2d535375da">aws_cryptosdk_enc_ctx_clean_up</a>(<span class="keyword">struct</span> aws_hash_table *enc_ctx) {</div>
133-
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> AWS_PRECONDITION(enc_ctx != NULL);</div>
134-
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> AWS_PRECONDITION(</div>
135-
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> enc_ctx-&gt;p_impl == NULL || aws_hash_table_is_valid(enc_ctx),</div>
136-
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="stringliteral">&quot;Input aws_hash_table [map] must be valid or hash_table_state pointer [map-&gt;p_impl] must be NULL, in case &quot;</span></div>
137-
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="stringliteral">&quot;aws_hash_table_clean_up was called twice.&quot;</span>);</div>
138-
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> aws_hash_table_clean_up(enc_ctx);</div>
139-
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> AWS_POSTCONDITION(enc_ctx-&gt;p_impl == NULL);</div>
140-
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span>}</div>
124+
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="group__enc__ctx.html#ga8211f26569678ab6c27b800744918594"> 64</a></span>AWS_CRYPTOSDK_STATIC_INLINE <span class="keywordtype">void</span> <a class="code hl_function" href="group__enc__ctx.html#ga8211f26569678ab6c27b800744918594">aws_cryptosdk_enc_ctx_clear</a>(<span class="keyword">struct</span> aws_hash_table *enc_ctx) {</div>
125+
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> AWS_PRECONDITION(aws_hash_table_is_valid(enc_ctx));</div>
126+
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> aws_hash_table_clear(enc_ctx);</div>
127+
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> AWS_PRECONDITION(aws_hash_table_is_valid(enc_ctx));</div>
128+
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>}</div>
129+
</div>
130+
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span></div>
131+
<div class="foldopen" id="foldopen00074" data-start="{" data-end="}">
132+
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="group__enc__ctx.html#gac0c62f7ada92e9fc625ffb2d535375da"> 74</a></span>AWS_CRYPTOSDK_STATIC_INLINE <span class="keywordtype">void</span> <a class="code hl_function" href="group__enc__ctx.html#gac0c62f7ada92e9fc625ffb2d535375da">aws_cryptosdk_enc_ctx_clean_up</a>(<span class="keyword">struct</span> aws_hash_table *enc_ctx) {</div>
133+
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> AWS_PRECONDITION(enc_ctx != NULL);</div>
134+
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> AWS_PRECONDITION(</div>
135+
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> enc_ctx-&gt;p_impl == NULL || aws_hash_table_is_valid(enc_ctx),</div>
136+
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="stringliteral">&quot;Input aws_hash_table [map] must be valid or hash_table_state pointer [map-&gt;p_impl] must be NULL, in case &quot;</span></div>
137+
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="stringliteral">&quot;aws_hash_table_clean_up was called twice.&quot;</span>);</div>
138+
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> aws_hash_table_clean_up(enc_ctx);</div>
139+
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> AWS_POSTCONDITION(enc_ctx-&gt;p_impl == NULL);</div>
140+
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span>}</div>
141141
</div>
142-
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span></div>
143-
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>AWS_CRYPTOSDK_API</div>
144-
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="group__enc__ctx.html#gaaa3836971063fe37bafeb1eaeb549365"> 87</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="group__enc__ctx.html#gaaa3836971063fe37bafeb1eaeb549365">aws_cryptosdk_enc_ctx_clone</a>(</div>
145-
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">struct</span> aws_allocator *alloc, <span class="keyword">struct</span> aws_hash_table *dest, <span class="keyword">const</span> <span class="keyword">struct</span> aws_hash_table *src);</div>
146-
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// doxygen group enc_ctx</span></div>
147-
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
148-
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#ifdef __cplusplus</span></div>
149-
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>}</div>
150-
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="preprocessor">#endif</span></div>
151-
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
152-
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="preprocessor">#endif </span><span class="comment">// AWS_CRYPTOSDK_ENC_CTX_H</span></div>
153-
<div class="ttc" id="agroup__enc__ctx_html_ga8211f26569678ab6c27b800744918594"><div class="ttname"><a href="group__enc__ctx.html#ga8211f26569678ab6c27b800744918594">aws_cryptosdk_enc_ctx_clear</a></div><div class="ttdeci">void aws_cryptosdk_enc_ctx_clear(struct aws_hash_table *enc_ctx)</div><div class="ttdef"><b>Definition</b> <a href="#l00054">enc_ctx.h:54</a></div></div>
142+
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span></div>
143+
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span>AWS_CRYPTOSDK_API</div>
144+
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="group__enc__ctx.html#gaaa3836971063fe37bafeb1eaeb549365"> 97</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="group__enc__ctx.html#gaaa3836971063fe37bafeb1eaeb549365">aws_cryptosdk_enc_ctx_clone</a>(</div>
145+
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">struct</span> aws_allocator *alloc, <span class="keyword">struct</span> aws_hash_table *dest, <span class="keyword">const</span> <span class="keyword">struct</span> aws_hash_table *src);</div>
146+
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// doxygen group enc_ctx</span></div>
147+
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
148+
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="preprocessor">#ifdef __cplusplus</span></div>
149+
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>}</div>
150+
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="preprocessor">#endif</span></div>
151+
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
152+
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="preprocessor">#endif </span><span class="comment">// AWS_CRYPTOSDK_ENC_CTX_H</span></div>
153+
<div class="ttc" id="agroup__enc__ctx_html_ga8211f26569678ab6c27b800744918594"><div class="ttname"><a href="group__enc__ctx.html#ga8211f26569678ab6c27b800744918594">aws_cryptosdk_enc_ctx_clear</a></div><div class="ttdeci">void aws_cryptosdk_enc_ctx_clear(struct aws_hash_table *enc_ctx)</div><div class="ttdef"><b>Definition</b> <a href="#l00064">enc_ctx.h:64</a></div></div>
154154
<div class="ttc" id="agroup__enc__ctx_html_gaaa3836971063fe37bafeb1eaeb549365"><div class="ttname"><a href="group__enc__ctx.html#gaaa3836971063fe37bafeb1eaeb549365">aws_cryptosdk_enc_ctx_clone</a></div><div class="ttdeci">int aws_cryptosdk_enc_ctx_clone(struct aws_allocator *alloc, struct aws_hash_table *dest, const struct aws_hash_table *src)</div></div>
155155
<div class="ttc" id="agroup__enc__ctx_html_gabdbdc0f509405b9f874dda486507ff12"><div class="ttname"><a href="group__enc__ctx.html#gabdbdc0f509405b9f874dda486507ff12">aws_cryptosdk_enc_ctx_init</a></div><div class="ttdeci">int aws_cryptosdk_enc_ctx_init(struct aws_allocator *alloc, struct aws_hash_table *enc_ctx)</div></div>
156-
<div class="ttc" id="agroup__enc__ctx_html_gac0c62f7ada92e9fc625ffb2d535375da"><div class="ttname"><a href="group__enc__ctx.html#gac0c62f7ada92e9fc625ffb2d535375da">aws_cryptosdk_enc_ctx_clean_up</a></div><div class="ttdeci">void aws_cryptosdk_enc_ctx_clean_up(struct aws_hash_table *enc_ctx)</div><div class="ttdef"><b>Definition</b> <a href="#l00064">enc_ctx.h:64</a></div></div>
156+
<div class="ttc" id="agroup__enc__ctx_html_gac0c62f7ada92e9fc625ffb2d535375da"><div class="ttname"><a href="group__enc__ctx.html#gac0c62f7ada92e9fc625ffb2d535375da">aws_cryptosdk_enc_ctx_clean_up</a></div><div class="ttdeci">void aws_cryptosdk_enc_ctx_clean_up(struct aws_hash_table *enc_ctx)</div><div class="ttdef"><b>Definition</b> <a href="#l00074">enc_ctx.h:74</a></div></div>
157157
</div><!-- fragment --></div><!-- contents -->
158158
<!-- start footer part -->
159159
<hr class="footer"/><address class="footer"><small>

html/error_8h.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@
167167
</table><table class="memberdecls">
168168
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
169169
Functions</h2></td></tr>
170-
<tr class="memitem:ga50773fe0117adb36ff60d1b995418347" id="r_ga50773fe0117adb36ff60d1b995418347"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga50773fe0117adb36ff60d1b995418347">aws_cryptosdk_load_error_strings</a> ()</td></tr>
171-
<tr class="separator:ga50773fe0117adb36ff60d1b995418347"><td class="memSeparator" colspan="2">&#160;</td></tr>
170+
<tr class="memitem:ga8ec3b2a13f0a67d03f74ddeff5e9c23f" id="r_ga8ec3b2a13f0a67d03f74ddeff5e9c23f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__error.html#ga8ec3b2a13f0a67d03f74ddeff5e9c23f">aws_cryptosdk_load_error_strings</a> (void)</td></tr>
171+
<tr class="separator:ga8ec3b2a13f0a67d03f74ddeff5e9c23f"><td class="memSeparator" colspan="2">&#160;</td></tr>
172172
</table>
173173
</div><!-- contents -->
174174
<!-- start footer part -->

0 commit comments

Comments
 (0)