Skip to content

Commit

Permalink
Regenerates documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@HugoFara
HugoFara committed Dec 27, 2023
1 parent a1b42cf commit b64cd6a
Show file tree
Hide file tree
Showing 284 changed files with 15,621 additions and 16,148 deletions.
5 changes: 3 additions & 2 deletions docs/html/ajax__add__term__transl_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,11 +145,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae95444187deb18ec23aaae65
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>string|array [new word ID, lowercase $text] if success, error message otherwise</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>(int|string)[]|string [new word ID, lowercase $text] if success, error message otherwise</dd></dl>
<p>@global string $tbpref Database table prefix</p>
<dl class="section since"><dt>Since</dt><dd>2.9.0 Error messages are much more explicit </dd>
<dd>
2.9.0 Return an array </dd></dl>
2.9.0 Return an array</dd></dl>
<p>@psalm-return list{int, string}|string </p>

</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/ajax__chg__term__status_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,8 +251,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3c8244e6e3c6154a02c60d20
<p>Force a term to get a new status.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$wid</td><td>ID of the word to edit </td></tr>
<tr><td class="paramtype">string</td><td class="paramname">$status</td><td>New status to set</td></tr>
<tr><td class="paramtype">string&#160;|&#160;int</td><td class="paramname">$wid</td><td>ID of the word to edit </td></tr>
<tr><td class="paramtype">string&#160;|&#160;int</td><td class="paramname">$status</td><td>New status to set</td></tr>
</table>
</dd>
</dl>
Expand Down
9 changes: 5 additions & 4 deletions docs/html/ajax__edit__impr__text_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a662fcd11e250f0e45005af13
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>array Return the useful data to edit a term annotation on a specific text. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>(array|int|null|string)[] Return the useful data to edit a term annotation on a specific text.</dd></dl>
<p>@psalm-return array{term_lc?: string, wid?: int|null, trans?: string, ann_index?: int&lt;0, max&gt;, term_ord?: int, translations?: array, lang_id?: int, error?: 'Annotation line is ill-formatted'|'Annotation not found'} </p>

</div>
</div>
Expand All @@ -271,7 +272,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#abd9c5830dc5f5c3424cd6b9d
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>array Return the possible translations. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>string[] Return the possible translations.</dd></dl>
<p>@psalm-return list&lt;non-empty-string&gt; </p>

</div>
</div>
Expand Down Expand Up @@ -310,8 +312,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a46e63dae67b9dbb66315a4a0
</dl>
<dl class="section return"><dt>Returns</dt><dd>string[] HTML output and JS output</dd></dl>
<p>@global string $tbpref Database table prefix.</p>
<p>@psalm-return array{0: string, 1: string}</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000018">Deprecated:</a></b></dt><dd>2.9.0 Use AJAX instead </dd></dl>
<p>@psalm-return list{string, string} </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000018">Deprecated:</a></b></dt><dd>2.9.0 Use AJAX instead </dd></dl>

</div>
</div>
Expand Down
3 changes: 2 additions & 1 deletion docs/html/ajax__save__impr__text_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3c55eb07eeaff73cbfd59ab8
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>string[] Result as array, with answer on "error" or "success" </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>string[] Result as array, with answer on "error" or "success"</dd></dl>
<p>@psalm-return array{error?: string, success?: 'OK'} </p>

</div>
</div>
Expand Down
42 changes: 39 additions & 3 deletions docs/html/ajax__show__imported__terms_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,7 @@
<tr class="separator:a90ad979fa054993e654fa18a77d9f344"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37b83d29ea67a121f5ce9b0e9f12b0aa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ajax__show__imported__terms_8php.html#a37b83d29ea67a121f5ce9b0e9f12b0aa">get_imported_terms</a> ($recno, $currentpage, $last_update)</td></tr>
<tr class="separator:a37b83d29ea67a121f5ce9b0e9f12b0aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad999521f7af55ae45734619e89f5d8d4"><td class="memItemLeft" align="right" valign="top"><a id="ad999521f7af55ae45734619e89f5d8d4" name="ad999521f7af55ae45734619e89f5d8d4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>select_imported_terms</b> ($last_update, $offset, $max_terms)</td></tr>
<tr class="memitem:ad999521f7af55ae45734619e89f5d8d4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ajax__show__imported__terms_8php.html#ad999521f7af55ae45734619e89f5d8d4">select_imported_terms</a> ($last_update, $offset, $max_terms)</td></tr>
<tr class="separator:ad999521f7af55ae45734619e89f5d8d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa912e01ec930bdf3029b68fceefa52c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ajax__show__imported__terms_8php.html#afa912e01ec930bdf3029b68fceefa52c">show_imported_terms</a> ($last_update, $limit, $rtl)</td></tr>
<tr class="separator:afa912e01ec930bdf3029b68fceefa52c"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -301,7 +300,44 @@ <h2 class="memtitle"><span class="permalink"><a href="#adf46fed6294216fcda2982dd
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>array </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>((int|mixed)[]|mixed)[]</dd></dl>
<p>@psalm-return array{navigation: array{current_page: mixed, total_pages: int}, terms: mixed} </p>

</div>
</div>
<a id="ad999521f7af55ae45734619e89f5d8d4" name="ad999521f7af55ae45734619e89f5d8d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad999521f7af55ae45734619e89f5d8d4">&#9670;&#160;</a></span>select_imported_terms()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">select_imported_terms </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$last_update</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$max_terms</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>(float|int|null|string)[][]</dd></dl>
<p>@psalm-return list&lt;list&lt;float|int|null|string&gt;&gt; </p>

</div>
</div>
Expand Down
13 changes: 7 additions & 6 deletions docs/html/all__words__wellknown_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Setting all unknown words to Well Known (99) </p>
<p>Call: <a class="el" href="all__words__wellknown_8php.html" title="Setting all unknown words to Well Known (99)">all_words_wellknown.php</a>?text=[textid] (mark all words as well-known) <a class="el" href="all__words__wellknown_8php.html" title="Setting all unknown words to Well Known (99)">all_words_wellknown.php</a>?text=[textid]&amp;status=[statusint] (mark with a specific status, normally 98 or 99) </p>
<p>Call: <a class="el" href="all__words__wellknown_8php.html" title="Setting all unknown words to Well Known (99)">all_words_wellknown.php</a>?text=[textid] (mark all words as well-known) <a class="el" href="all__words__wellknown_8php.html" title="Setting all unknown words to Well Known (99)">all_words_wellknown.php</a>?text=[textid]&amp;status=[statusint] (mark with a specific status, normally 98 or 99)</p>
<p>PHP version 8.1 </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a892bafeaaaff5f1fff8f32be0dbbbec8" name="a892bafeaaaff5f1fff8f32be0dbbbec8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a892bafeaaaff5f1fff8f32be0dbbbec8">&#9670;&#160;</a></span>all_words_wellknown_content()</h2>
Expand Down Expand Up @@ -274,7 +275,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6defdb6224f9f84b18e55be6
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">int</td><td class="paramname">$txid</td><td><a class="el" href="class_text.html">Text</a> ID </td></tr>
<tr><td class="paramtype">int</td><td class="paramname">$javascript</td><td>JavaScript-formatted string.</td></tr>
<tr><td class="paramtype">string</td><td class="paramname">$javascript</td><td>JavaScript-formatted string.</td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -315,9 +316,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa7aecd66a19c9867d139fc39
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>(int|string)[] Number of edited words, and JavaScript query to change their display</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>array [int, string] Number of edited words, and JavaScript query to change their display</dd></dl>
<dl class="section since"><dt>Since</dt><dd>2.5.3-fork Use 'let' instead of 'var' in returned JS</dd></dl>
<p>@psalm-return array{0: int, 1: string} </p>
<p>@psalm-return list{int, string} </p>

</div>
</div>
Expand Down Expand Up @@ -368,11 +369,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6300e9558f4e64dfbe77dde0
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>(int|string)[] Number of rows edited and a javascript query.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>array [int, string] Number of rows edited and a javascript query.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>2.5.3-fork Do not crash when echoing an error </dd>
<dd>
2.5.3-fork Do not crash when a word is already registred to the database</dd></dl>
<p>@psalm-return array{0: int, 1: string} </p>
<p>@psalm-return list{int, string} </p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/backup__restore_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Backup/Restore/Empty LWT Database. </p>
<p>Call: <a class="el" href="backup__restore_8php.html" title="Backup/Restore/Empty LWT Database.">backup_restore.php</a>?.... ... restore=xxx ... do restore ... backup=xxx ... do backup ... empty=xxx ... do truncate</p>
<p>php version 8.1.12 </p>
<p>PHP version 8.1 </p>
</div><h2 class="groupheader">Variable Documentation</h2>
<a id="af3d5667b398139aa18cb5693e35b28ba" name="af3d5667b398139aa18cb5693e35b28ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3d5667b398139aa18cb5693e35b28ba">&#9670;&#160;</a></span>else</h2>
Expand Down
5 changes: 3 additions & 2 deletions docs/html/bulk__translate__words_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Translate groups of words. </p>
<p>Call: <a class="el" href="bulk__translate__words_8php.html" title="Translate groups of words.">bulk_translate_words.php</a>?.... ... tid=[textid] ... Vocabulary from this text ... sl=[sourcelg] ... Source language (usually two letters) ... tl=[targetlg] ... Target language (usually two letters) ... term=[term] ... <a class="el" href="class_term.html">Term</a> to translate ... offset=[pos] ... An optional offset position </p>
<p>Call: <a class="el" href="bulk__translate__words_8php.html" title="Translate groups of words.">bulk_translate_words.php</a>?.... ... tid=[textid] ... Vocabulary from this text ... sl=[sourcelg] ... Source language (usually two letters) ... tl=[targetlg] ... Target language (usually two letters) ... term=[term] ... <a class="el" href="class_term.html">Term</a> to translate ... offset=[pos] ... An optional offset position</p>
<p>PHP version 8.1 </p>
</div><h2 class="groupheader">Variable Documentation</h2>
<a id="ab84d60561a29dc90e9376852ed56ba4e" name="ab84d60561a29dc90e9376852ed56ba4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab84d60561a29dc90e9376852ed56ba4e">&#9670;&#160;</a></span>else</h2>
Expand All @@ -121,7 +122,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab84d60561a29dc90e9376852
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">{</div>
<div class="line"> <a class="code hl_function" href="session__utility_8php.html#aa2ddde28f52334e0f6b8bfc1b89c12cb">pagestart_nobody</a>(<span class="stringliteral">&#39;Translate New Words&#39;</span>)</div>
<div class="ttc" id="asession__utility_8php_html_aa2ddde28f52334e0f6b8bfc1b89c12cb"><div class="ttname"><a href="session__utility_8php.html#aa2ddde28f52334e0f6b8bfc1b89c12cb">pagestart_nobody</a></div><div class="ttdeci">pagestart_nobody($title, $addcss='')</div><div class="ttdef"><b>Definition:</b> session_utility.php:5246</div></div>
<div class="ttc" id="asession__utility_8php_html_aa2ddde28f52334e0f6b8bfc1b89c12cb"><div class="ttname"><a href="session__utility_8php.html#aa2ddde28f52334e0f6b8bfc1b89c12cb">pagestart_nobody</a></div><div class="ttdeci">pagestart_nobody($title, $addcss='')</div><div class="ttdef"><b>Definition:</b> session_utility.php:5315</div></div>
</div><!-- fragment -->
</div>
</div>
Expand Down
7 changes: 4 additions & 3 deletions docs/html/check__text_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,8 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Check (parse &amp; split) a <a class="el" href="class_text.html">Text</a> (into sentences/words) </p>
<p>Call: <a class="el" href="check__text_8php.html" title="Check (parse &amp; split) a Text (into sentences/words)">check_text.php</a>?... op=Check ... do the check </p>
<p>Call: <a class="el" href="check__text_8php.html" title="Check (parse &amp; split) a Text (into sentences/words)">check_text.php</a>?... op=Check ... do the check</p>
<p>PHP version 8.1 </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a2920939de4f85e348ae543485dacce3e" name="a2920939de4f85e348ae543485dacce3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2920939de4f85e348ae543485dacce3e">&#9670;&#160;</a></span>display_form()</h2>
Expand All @@ -121,7 +122,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2920939de4f85e348ae54348
<p>@global string $tbpref</p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<p>Change the language of inputs for text and title based on selected language.</p>
<dl class="section return"><dt>Returns</dt><dd>undefined</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>{undefined}</dd></dl>

</div>
</div>
Expand Down Expand Up @@ -176,7 +177,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9af791c89a65404f1f6fa3ee
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">{</div>
<div class="line"> <a class="code hl_function" href="check__text_8php.html#a2920939de4f85e348ae543485dacce3e">display_form</a>()</div>
<div class="ttc" id="acheck__text_8php_html_a2920939de4f85e348ae543485dacce3e"><div class="ttname"><a href="check__text_8php.html#a2920939de4f85e348ae543485dacce3e">Lwt\Interface\Check_Text\display_form</a></div><div class="ttdeci">display_form()</div><div class="ttdef"><b>Definition:</b> check_text.php:47</div></div>
<div class="ttc" id="acheck__text_8php_html_a2920939de4f85e348ae543485dacce3e"><div class="ttname"><a href="check__text_8php.html#a2920939de4f85e348ae543485dacce3e">Lwt\Interface\Check_Text\display_form</a></div><div class="ttdeci">display_form()</div><div class="ttdef"><b>Definition:</b> check_text.php:50</div></div>
</div><!-- fragment -->
</div>
</div>
Expand Down
1 change: 1 addition & 0 deletions docs/html/connect__easyphp_8inc_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>DB variables for EasyPHP. </p>
<p>PHP version 8.1</p>
<dl class="section author"><dt>Author</dt><dd><a href="https://sourceforge.net/projects/lwt/">https://sourceforge.net/projects/lwt/</a> LWT Project </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.3 </dd></dl>
</div></div><!-- contents -->
Expand Down
1 change: 1 addition & 0 deletions docs/html/connect__mamp_8inc_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>DB variables for MAMP. </p>
<p>PHP version 8.1 </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
1 change: 1 addition & 0 deletions docs/html/connect__wordpress_8inc_8php.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
<a href="#details">More...</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>DB variables when LWT is integrated with WordPress. </p>
<p>PHP version 8.1</p>
<dl class="section author"><dt>Author</dt><dd><a href="https://sourceforge.net/projects/lwt/">https://sourceforge.net/projects/lwt/</a> LWT Project </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.5.5 </dd></dl>
</div></div><!-- contents -->
Expand Down
Loading

0 comments on commit b64cd6a

Please sign in to comment.