Skip to content

Commit 0553b8c

Browse files
committed
doxygen
1 parent 434d43b commit 0553b8c

29 files changed

+293
-245
lines changed

docs/html/_audio_dictionary_8h_source.html

Lines changed: 112 additions & 110 deletions
Large diffs are not rendered by default.

docs/html/_text_to_speech_queue_8h_source.html

Lines changed: 96 additions & 82 deletions
Large diffs are not rendered by default.

docs/html/classsimple__tts_1_1_text_to_speech_queue-members.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,14 @@
8888
<tr bgcolor="#f0f0f0"><td class="entry"><b>p_sink</b> (defined in <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a>)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
8989
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>p_tts</b> (defined in <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a>)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
9090
<tr bgcolor="#f0f0f0"><td class="entry"><b>process</b>() (defined in <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a>)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
91-
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>queue</b> (defined in <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a>)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
92-
<tr><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a209230ab9488a96986199e2fdb264016">say</a>(const char *word)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
93-
<tr class="even"><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#af6ae6fd328a073cd9b386881e0a10890">say</a>(const char *word[], int size)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
94-
<tr><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a990fdaf4629913f1c7b542a25aac8f33">say</a>(char *(&amp;word)[N])</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
95-
<tr class="even"><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#ad946ed72d69896178a587ad57ff04c1a">say</a>(audio_tools::Vector&lt; const char * &gt; words)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
96-
<tr><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#abc85a3fedac7b291c783440d2112ca79">sayNow</a>(const char *word)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
91+
<tr class="even"><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a283909e83d0b0ee0cf2a5f8ad19a5358">processWord</a>(const char *word)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
92+
<tr bgcolor="#f0f0f0"><td class="entry"><b>queue</b> (defined in <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a>)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
93+
<tr class="even"><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a209230ab9488a96986199e2fdb264016">say</a>(const char *word)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
94+
<tr><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#af6ae6fd328a073cd9b386881e0a10890">say</a>(const char *word[], int size)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
95+
<tr class="even"><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a990fdaf4629913f1c7b542a25aac8f33">say</a>(char *(&amp;word)[N])</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
96+
<tr><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#ad946ed72d69896178a587ad57ff04c1a">say</a>(audio_tools::Vector&lt; const char * &gt; words)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
97+
<tr class="even"><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#abc85a3fedac7b291c783440d2112ca79">sayNow</a>(const char *word)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
98+
<tr><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a0ee45611587039062104c1ed7f6cac35">silence</a>(int n=1)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
9799
<tr class="even"><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#ad02e6edf96cf855bbd8721dd4f5f3f43">size</a>()</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
98100
<tr><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#ab33ad51a66945e59edae75460dd023e6">TextToSpeechQueue</a>(SimpleTTSBase &amp;tts, AudioStream &amp;sink, AudioDecoder &amp;decoder, AudioDictionaryBase &amp;dict)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
99101
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>TextToSpeechQueue</b>(SimpleTTSBase &amp;tts, AudioPrint &amp;sink, AudioDecoder &amp;decoder, AudioDictionaryBase &amp;dict) (defined in <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a>)</td><td class="entry"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html">simple_tts::TextToSpeechQueue</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>

docs/html/classsimple__tts_1_1_text_to_speech_queue.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,14 @@
117117
<tr class="memitem:a997cf5bbccb7fb2a13c705abf11d06ea"><td class="memItemLeft" align="right" valign="top"><a id="a997cf5bbccb7fb2a13c705abf11d06ea"></a>
118118
void&#160;</td><td class="memItemRight" valign="bottom"><b>process</b> ()</td></tr>
119119
<tr class="separator:a997cf5bbccb7fb2a13c705abf11d06ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
120+
<tr class="memitem:a283909e83d0b0ee0cf2a5f8ad19a5358"><td class="memItemLeft" align="right" valign="top"><a id="a283909e83d0b0ee0cf2a5f8ad19a5358"></a>
121+
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a283909e83d0b0ee0cf2a5f8ad19a5358">processWord</a> (const char *word)</td></tr>
122+
<tr class="memdesc:a283909e83d0b0ee0cf2a5f8ad19a5358"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output of word to audio sink. <br /></td></tr>
123+
<tr class="separator:a283909e83d0b0ee0cf2a5f8ad19a5358"><td class="memSeparator" colspan="2">&#160;</td></tr>
124+
<tr class="memitem:a0ee45611587039062104c1ed7f6cac35"><td class="memItemLeft" align="right" valign="top"><a id="a0ee45611587039062104c1ed7f6cac35"></a>
125+
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a0ee45611587039062104c1ed7f6cac35">silence</a> (int n=1)</td></tr>
126+
<tr class="memdesc:a0ee45611587039062104c1ed7f6cac35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends silence to mp3 decoder for n secods. <br /></td></tr>
127+
<tr class="separator:a0ee45611587039062104c1ed7f6cac35"><td class="memSeparator" colspan="2">&#160;</td></tr>
120128
<tr class="memitem:ad02e6edf96cf855bbd8721dd4f5f3f43"><td class="memItemLeft" align="right" valign="top"><a id="ad02e6edf96cf855bbd8721dd4f5f3f43"></a>
121129
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#ad02e6edf96cf855bbd8721dd4f5f3f43">size</a> ()</td></tr>
122130
<tr class="memdesc:ad02e6edf96cf855bbd8721dd4f5f3f43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of words to be spoken in the queue. <br /></td></tr>

docs/html/functions.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,9 @@ <h3><a id="index_p"></a>- p -</h3><ul>
143143
<li>process()
144144
: <a class="el" href="classsimple__tts_1_1_number_unit_to_text.html#aa2ef301472f16644e12ca377537188a0">simple_tts::NumberUnitToText</a>
145145
</li>
146+
<li>processWord()
147+
: <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a283909e83d0b0ee0cf2a5f8ad19a5358">simple_tts::TextToSpeechQueue</a>
148+
</li>
146149
</ul>
147150

148151

@@ -157,6 +160,9 @@ <h3><a id="index_s"></a>- s -</h3><ul>
157160
<li>sayNow()
158161
: <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#abc85a3fedac7b291c783440d2112ca79">simple_tts::TextToSpeechQueue</a>
159162
</li>
163+
<li>silence()
164+
: <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a0ee45611587039062104c1ed7f6cac35">simple_tts::TextToSpeechQueue</a>
165+
</li>
160166
<li>size()
161167
: <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#ad02e6edf96cf855bbd8721dd4f5f3f43">simple_tts::TextToSpeechQueue</a>
162168
</li>

docs/html/functions_func.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,9 @@ <h3><a id="index_p"></a>- p -</h3><ul>
136136
<li>process()
137137
: <a class="el" href="classsimple__tts_1_1_number_unit_to_text.html#aa2ef301472f16644e12ca377537188a0">simple_tts::NumberUnitToText</a>
138138
</li>
139+
<li>processWord()
140+
: <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a283909e83d0b0ee0cf2a5f8ad19a5358">simple_tts::TextToSpeechQueue</a>
141+
</li>
139142
</ul>
140143

141144

@@ -150,6 +153,9 @@ <h3><a id="index_s"></a>- s -</h3><ul>
150153
<li>sayNow()
151154
: <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#abc85a3fedac7b291c783440d2112ca79">simple_tts::TextToSpeechQueue</a>
152155
</li>
156+
<li>silence()
157+
: <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#a0ee45611587039062104c1ed7f6cac35">simple_tts::TextToSpeechQueue</a>
158+
</li>
153159
<li>size()
154160
: <a class="el" href="classsimple__tts_1_1_text_to_speech_queue.html#ad02e6edf96cf855bbd8721dd4f5f3f43">simple_tts::TextToSpeechQueue</a>
155161
</li>

docs/html/search/all_a.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
var searchData=
22
[
3-
['process_25',['process',['../classsimple__tts_1_1_number_unit_to_text.html#aa2ef301472f16644e12ca377537188a0',1,'simple_tts::NumberUnitToText']]]
3+
['process_25',['process',['../classsimple__tts_1_1_number_unit_to_text.html#aa2ef301472f16644e12ca377537188a0',1,'simple_tts::NumberUnitToText']]],
4+
['processword_26',['processWord',['../classsimple__tts_1_1_text_to_speech_queue.html#a283909e83d0b0ee0cf2a5f8ad19a5358',1,'simple_tts::TextToSpeechQueue']]]
45
];

docs/html/search/all_b.js

Lines changed: 6 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/html/search/all_c.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)