Skip to content

Commit

Permalink
Regenerated documentation.
Browse files Browse the repository at this point in the history 
Updated doxygen from 1.9.3 to 1.9.6.
  • Loading branch information
@HugoFara
HugoFara committed Jan 1, 2023
1 parent 4a912ea commit bec1ae9
Show file tree
Hide file tree
Showing 252 changed files with 6,879 additions and 3,887 deletions.
8 changes: 5 additions & 3 deletions docs/CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For git tags, official releases are marked like "v1.0.0", while unofficial ones
* Psalm static code analysis of all PHP files.
* We use "EOP" for end-of-paragraph markers instead of misleading "EOS" (MeCab).
* Slightly changed how a connection is established with SQL. It makes messages more relevant when SQL is not running.
* Not-japanese texts now always use the PHP parser. The SQL parser is no longer used.
* Not Japanese texts now always use the PHP parser. The SQL parser is no longer used.
* JS: Some deprecated functions ``escape`` and ``unescape`` were replaced by modern equivalents ``encodeURIcomponent`` and ``decodeURIcomponent``. This may lead to changes in cookies, notably making them work better.
* DB: the NO_ZERO_DATE mode is no longer required, see [#78](https://github.com/HugoFara/lwt/issues/78).
* In the ``words`` table, replaced the default timestamp ``0000-00-00 00:00:00`` by ``0000-00-00 00:00:01``.
Expand All @@ -40,7 +40,7 @@ For git tags, official releases are marked like "v1.0.0", while unofficial ones
### Fixed
* Docker:
* Docker integration repaired ([#37](https://github.com/HugoFara/lwt/issues/37))! Huge thanks to [@hakuro-jp](https://github.com/hakuro-jp) for the initial help and [@darkone23](https://github.com/darkone23) for the final solution. Without you two I would have long given up with Docker.
* Docker continous integration is back as well due to a rewrite of the worflow.
* Docker continuous integration is back as well due to a rewrite of the workflow.
* Texts:
* The *audio* player was no longer working since 2.1.0-fork since the play button was hidden.
* Save text position (``inc/ajax_save_text_position.php``) was broken for all texts. This is fixed.
Expand All @@ -57,7 +57,7 @@ For git tags, official releases are marked like "v1.0.0", while unofficial ones
* Type fixes thanks to psalm:
* ``get_first_value`` documentation updated since it was also returning ``float`` and ``int``.
* ``get_similar_terms`` in ``simterms.php`` officially returns int.
* Unconsistent option in ``inc/ajax_save_setting.php``.
* Inconsistent option in ``inc/ajax_save_setting.php``.
* Since 2.2.2-fork, you had to use a GET request to use it, resulting in authorization errors.
* POST requests are now again the default way to use it.
* PHP tries to set the allow_local_infile option during the connection with SQL ([#20](https://github.com/HugoFara/lwt/issues/20), [#40](https://github.com/HugoFara/lwt/issues/40)).
Expand All @@ -68,6 +68,8 @@ For git tags, official releases are marked like "v1.0.0", while unofficial ones
* For some users it was impossible to install the default database due to the use of a ZERO date ([#78](https://github.com/HugoFara/lwt/issues/78)).
* Deleted wrong database instructions ``ADD DROP INDEX TiTextLC`` altering ``temptextitems`` in ``update_database`` of ``database_connect.php``.

### Full Changelog
* [2.5.3...2.6.0](https://github.com/HugoFara/lwt/compare/2.5.3...2.6.0)

## 2.5.3-fork (November 06 2022)
### Added
Expand Down
37 changes: 22 additions & 15 deletions docs/html/ajax__add__term__transl_8php.html
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Learning with Texts - Fork: inc/ajax_add_term_transl.php File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -22,7 +22,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="lwt_icon.png"/></td>
<td id="projectalign">
<div id="projectname">Learning with Texts - Fork<span id="projectnumber">&#160;2.5.3-fork</span>
<div id="projectname">Learning with Texts - Fork<span id="projectnumber">&#160;2.6.0-fork</span>
</div>
<div id="projectbrief">Learn foreign languages with texts</div>
</td>
Expand All @@ -31,10 +31,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
Expand All @@ -57,9 +57,16 @@

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
Expand Down Expand Up @@ -91,11 +98,11 @@
<tr class="separator:aae2fbf960fa44cb2a3b37ec7d34ef249"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Add a translation to term. </p>
<p >Call: <a class="el" href="ajax__add__term__transl_8php.html" title="Add a translation to term.">inc/ajax_add_term_transl.php</a> </p>
<div class="textblock"><p>Add a translation to term. </p>
<p>Call: <a class="el" href="ajax__add__term__transl_8php.html" title="Add a translation to term.">inc/ajax_add_term_transl.php</a> </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae95444187deb18ec23aaae657a69bfcb" name="ae95444187deb18ec23aaae657a69bfcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae95444187deb18ec23aaae657a69bfcb">&#9670;&nbsp;</a></span>add_new_term_transl()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#ae95444187deb18ec23aaae657a69bfcb">&#9670;&#160;</a></span>add_new_term_transl()</h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -125,7 +132,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae95444187deb18ec23aaae65
</tr>
</table>
</div><div class="memdoc">
<p >Add the translation for a new term.</p>
<p>Add the translation for a new term.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$text</td><td>Associated text </td></tr>
Expand All @@ -140,7 +147,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae95444187deb18ec23aaae65
</div>
</div>
<a id="aae2fbf960fa44cb2a3b37ec7d34ef249" name="aae2fbf960fa44cb2a3b37ec7d34ef249"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae2fbf960fa44cb2a3b37ec7d34ef249">&#9670;&nbsp;</a></span>edit_term_transl()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#aae2fbf960fa44cb2a3b37ec7d34ef249">&#9670;&#160;</a></span>edit_term_transl()</h2>

<div class="memitem">
<div class="memproto">
Expand All @@ -164,7 +171,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aae2fbf960fa44cb2a3b37ec7
</tr>
</table>
</div><div class="memdoc">
<p >Edit the translation for an existing term.</p>
<p>Edit the translation for an existing term.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">int</td><td class="paramname">$wid</td><td>Word ID </td></tr>
Expand All @@ -180,7 +187,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aae2fbf960fa44cb2a3b37ec7
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
41 changes: 24 additions & 17 deletions docs/html/ajax__check__regexp_8php.html
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Learning with Texts - Fork: inc/ajax_check_regexp.php File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Expand All @@ -22,7 +22,7 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="lwt_icon.png"/></td>
<td id="projectalign">
<div id="projectname">Learning with Texts - Fork<span id="projectnumber">&#160;2.5.3-fork</span>
<div id="projectname">Learning with Texts - Fork<span id="projectnumber">&#160;2.6.0-fork</span>
</div>
<div id="projectbrief">Learn foreign languages with texts</div>
</td>
Expand All @@ -31,10 +31,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
Expand All @@ -57,9 +57,16 @@

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
Expand Down Expand Up @@ -93,11 +100,11 @@
<tr class="separator:a406820966fd51ac9b2c5be8f063af4c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Check whether a regexp is valid, returns error message or empty string. </p>
<p >Call: <a class="el" href="ajax__check__regexp_8php.html" title="Check whether a regexp is valid, returns error message or empty string.">inc/ajax_check_regexp.php</a>?.... ... regex=regular_expression </p>
<div class="textblock"><p>Check whether a regexp is valid, returns error message or empty string. </p>
<p>Call: <a class="el" href="ajax__check__regexp_8php.html" title="Check whether a regexp is valid, returns error message or empty string.">inc/ajax_check_regexp.php</a>?.... ... regex=regular_expression </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a1d53b9916eca5ff3430bca9bf3f05ce6" name="a1d53b9916eca5ff3430bca9bf3f05ce6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d53b9916eca5ff3430bca9bf3f05ce6">&#9670;&nbsp;</a></span>check_mecab_accessibility()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#a1d53b9916eca5ff3430bca9bf3f05ce6">&#9670;&#160;</a></span>check_mecab_accessibility()</h2>

<div class="memitem">
<div class="memproto">
Expand All @@ -110,13 +117,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1d53b9916eca5ff3430bca9b
</tr>
</table>
</div><div class="memdoc">
<p >Check if mecab is installed and accessible under the 'mecab' alias.</p>
<p>Check if mecab is installed and accessible under the 'mecab' alias.</p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>

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

<div class="memitem">
<div class="memproto">
Expand All @@ -130,13 +137,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa8f063f0d4fc3bcffb174c94
</tr>
</table>
</div><div class="memdoc">
<p >Check if string 'test' is consistently recorgnized a word.</p>
<p>Check if string 'test' is consistently recorgnized a word.</p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>

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

<div class="memitem">
<div class="memproto">
Expand All @@ -150,7 +157,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a406820966fd51ac9b2c5be8f
</tr>
</table>
</div><div class="memdoc">
<p >Make the actual query to check the regex.</p>
<p>Make the actual query to check the regex.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$regex</td><td>Regex to test</td></tr>
Expand All @@ -164,7 +171,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a406820966fd51ac9b2c5be8f
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
Loading

0 comments on commit bec1ae9

Please sign in to comment.