Skip to content

Commit

Permalink
Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pu2clr committed Jul 18, 2024
1 parent 1e25413 commit f72c89b
Show file tree
Hide file tree
Showing 14 changed files with 386 additions and 301 deletions.
160 changes: 98 additions & 62 deletions extras/apidoc/def/doxygen.def

Large diffs are not rendered by default.

343 changes: 171 additions & 172 deletions extras/apidoc/html/_q_n8066_8h_source.html

Large diffs are not rendered by default.

25 changes: 13 additions & 12 deletions extras/apidoc/html/class_q_n8066-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -124,18 +124,19 @@
<tr class="odd"><td class="entry"><a class="el" href="group__group04.html#ga88ea23b676feb40a15725b9273eca95b">setTxFrequencyDerivation</a>(uint8_t value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group04.html#ga09843594c1c9203a738c3a18cbc78403">setTxInputBufferGain</a>(uint8_t value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group04.html#ga751bb2147b6355745b261cc8f86a017c">setTxInputImpedance</a>(uint8_t value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group04.html#ga59c9bd87716f1c0ffb1be2a143a95571">setTxOffAfterOneMinuteNoAudio</a>(bool value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group04.html#gad46b7a63f4c0887a2b0c9b1b068739d4">setTxPilotGain</a>(uint8_t value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group04.html#gab1a0d8a388d2ca976c67b2f31c4d8be1">setTxPreEmphasis</a>(uint8_t value=75)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group05.html#gaaad14424c57781256cfbda7accadbd49">setTxRDS</a>(bool value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group04.html#gab21e226857d1b2ac384623fd47784ce5">setTxSoftClippingEnable</a>(bool value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group04.html#ga0032c60d8038a749f69b7e8508fa014d">setTxSoftCliptTreshold</a>(uint8_t value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group04.html#ga7fbea7d2ae6bdf9719ee252e6a612a83">setTxStereo</a>(bool value=true)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group05.html#gaba2e2e1f2df33bb652fe36878355bc98">setTxToggleRDSReady</a>()</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group02.html#ga8eeb0b8b46c2539ce70f304b922c1a8f">setup</a>()</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_q_n8066.html#a8f5f8f73c0d0f1faa96a6b5bb8bde49b">startTransmitting</a>()</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_q_n8066.html#a801b74d0c6d39c9c828f20a46fb3ce7c">stopTransmitting</a>()</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group05.html#ga0664c14d7c23ede48874c9007b157d46">writeTxRDSBuffer</a>(char *text)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group04.html#gad1cad21dc29703b30df776dbbb98a08a">setTxOffAfterOneMinute</a>(uint8_t value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group04.html#ga59c9bd87716f1c0ffb1be2a143a95571">setTxOffAfterOneMinuteNoAudio</a>(bool value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group04.html#gad46b7a63f4c0887a2b0c9b1b068739d4">setTxPilotGain</a>(uint8_t value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group04.html#gab1a0d8a388d2ca976c67b2f31c4d8be1">setTxPreEmphasis</a>(uint8_t value=75)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group05.html#gaaad14424c57781256cfbda7accadbd49">setTxRDS</a>(bool value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group04.html#gab21e226857d1b2ac384623fd47784ce5">setTxSoftClippingEnable</a>(bool value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group04.html#ga0032c60d8038a749f69b7e8508fa014d">setTxSoftCliptTreshold</a>(uint8_t value)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group04.html#ga7fbea7d2ae6bdf9719ee252e6a612a83">setTxStereo</a>(bool value=true)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group05.html#gaba2e2e1f2df33bb652fe36878355bc98">setTxToggleRDSReady</a>()</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="group__group02.html#ga8eeb0b8b46c2539ce70f304b922c1a8f">setup</a>()</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_q_n8066.html#a8f5f8f73c0d0f1faa96a6b5bb8bde49b">startTransmitting</a>()</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_q_n8066.html#a801b74d0c6d39c9c828f20a46fb3ce7c">stopTransmitting</a>()</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="group__group05.html#ga0664c14d7c23ede48874c9007b157d46">writeTxRDSBuffer</a>(char *text)</td><td class="entry"><a class="el" href="class_q_n8066.html">QN8066</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
3 changes: 3 additions & 0 deletions extras/apidoc/html/class_q_n8066.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,9 @@
<tr class="memitem:ga59c9bd87716f1c0ffb1be2a143a95571"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group04.html#ga59c9bd87716f1c0ffb1be2a143a95571">setTxOffAfterOneMinuteNoAudio</a> (bool value)</td></tr>
<tr class="memdesc:ga59c9bd87716f1c0ffb1be2a143a95571"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set of 1 minute time for PA off when no audio. <br /></td></tr>
<tr class="separator:ga59c9bd87716f1c0ffb1be2a143a95571"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad1cad21dc29703b30df776dbbb98a08a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group04.html#gad1cad21dc29703b30df776dbbb98a08a">setTxOffAfterOneMinute</a> (uint8_t value)</td></tr>
<tr class="memdesc:gad1cad21dc29703b30df776dbbb98a08a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets PA Off after 1 minute time when no audio. <br /></td></tr>
<tr class="separator:gad1cad21dc29703b30df776dbbb98a08a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad46b7a63f4c0887a2b0c9b1b068739d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group04.html#gad46b7a63f4c0887a2b0c9b1b068739d4">setTxPilotGain</a> (uint8_t value)</td></tr>
<tr class="memdesc:gad46b7a63f4c0887a2b0c9b1b068739d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gain of TX pilot to adjust pilot frequency deviation. <br /></td></tr>
<tr class="separator:gad46b7a63f4c0887a2b0c9b1b068739d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down
1 change: 1 addition & 0 deletions extras/apidoc/html/class_q_n8066.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ var class_q_n8066 =
[ "setTxStereo", "group__group04.html#ga7fbea7d2ae6bdf9719ee252e6a612a83", null ],
[ "setTxPreEmphasis", "group__group04.html#gab1a0d8a388d2ca976c67b2f31c4d8be1", null ],
[ "setTxOffAfterOneMinuteNoAudio", "group__group04.html#ga59c9bd87716f1c0ffb1be2a143a95571", null ],
[ "setTxOffAfterOneMinute", "group__group04.html#gad1cad21dc29703b30df776dbbb98a08a", null ],
[ "setTxPilotGain", "group__group04.html#gad46b7a63f4c0887a2b0c9b1b068739d4", null ],
[ "setAudioAnalogGain", "group__group04.html#ga85384e9b43f34c41e7b9d4699cb6bfc7", null ],
[ "setAudioDigitalGain", "group__group04.html#ga4670b899f6f3df01c4d967b7f461318a", null ],
Expand Down
1 change: 1 addition & 0 deletions extras/apidoc/html/functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ <h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>setTxFrequencyDerivation()&#160;:&#160;<a class="el" href="group__group04.html#ga88ea23b676feb40a15725b9273eca95b">QN8066</a></li>
<li>setTxInputBufferGain()&#160;:&#160;<a class="el" href="group__group04.html#ga09843594c1c9203a738c3a18cbc78403">QN8066</a></li>
<li>setTxInputImpedance()&#160;:&#160;<a class="el" href="group__group04.html#ga751bb2147b6355745b261cc8f86a017c">QN8066</a></li>
<li>setTxOffAfterOneMinute()&#160;:&#160;<a class="el" href="group__group04.html#gad1cad21dc29703b30df776dbbb98a08a">QN8066</a></li>
<li>setTxOffAfterOneMinuteNoAudio()&#160;:&#160;<a class="el" href="group__group04.html#ga59c9bd87716f1c0ffb1be2a143a95571">QN8066</a></li>
<li>setTxPilotGain()&#160;:&#160;<a class="el" href="group__group04.html#gad46b7a63f4c0887a2b0c9b1b068739d4">QN8066</a></li>
<li>setTxPreEmphasis()&#160;:&#160;<a class="el" href="group__group04.html#gab1a0d8a388d2ca976c67b2f31c4d8be1">QN8066</a></li>
Expand Down
1 change: 1 addition & 0 deletions extras/apidoc/html/functions_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ <h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>setTxFrequencyDerivation()&#160;:&#160;<a class="el" href="group__group04.html#ga88ea23b676feb40a15725b9273eca95b">QN8066</a></li>
<li>setTxInputBufferGain()&#160;:&#160;<a class="el" href="group__group04.html#ga09843594c1c9203a738c3a18cbc78403">QN8066</a></li>
<li>setTxInputImpedance()&#160;:&#160;<a class="el" href="group__group04.html#ga751bb2147b6355745b261cc8f86a017c">QN8066</a></li>
<li>setTxOffAfterOneMinute()&#160;:&#160;<a class="el" href="group__group04.html#gad1cad21dc29703b30df776dbbb98a08a">QN8066</a></li>
<li>setTxOffAfterOneMinuteNoAudio()&#160;:&#160;<a class="el" href="group__group04.html#ga59c9bd87716f1c0ffb1be2a143a95571">QN8066</a></li>
<li>setTxPilotGain()&#160;:&#160;<a class="el" href="group__group04.html#gad46b7a63f4c0887a2b0c9b1b068739d4">QN8066</a></li>
<li>setTxPreEmphasis()&#160;:&#160;<a class="el" href="group__group04.html#gab1a0d8a388d2ca976c67b2f31c4d8be1">QN8066</a></li>
Expand Down
3 changes: 1 addition & 2 deletions extras/apidoc/html/group__group00.html
Original file line number Diff line number Diff line change
Expand Up @@ -1991,8 +1991,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#structqn8066__gplt_8arg">
<td class="fieldname">
GAIN_TXPLT: 4</td>
<td class="fielddoc">
<p>Gain of TX pilot to adjust pilot frequency deviation. Refer to peak frequency deviation of MPX signal when audio input is full scale. </p>
</td></tr>
Gain of TX pilot to adjust pilot frequency deviation. Refer to peak frequency deviation of MPX signal when audio input is full scale. </td></tr>
<tr><td class="fieldtype">
<a id="a88bb33a1b20277073c4abf2592731ec2" name="a88bb33a1b20277073c4abf2592731ec2"></a>uint8_t</td>
<td class="fieldname">
Expand Down
Loading

0 comments on commit f72c89b

Please sign in to comment.