Skip to content

Commit

Permalink
New documentation, $langDefs is less used (#163) and warnings after l…
Browse files Browse the repository at this point in the history
…anguage rename (#113).

JS Doc is added with JS DOC and PHP Doc with phpDocumentor.
New global LWT_LANGUAGES_ARRAY.
When renaming a language, text to speech was broken, it is fixed.
  • Loading branch information
HugoFara committed Dec 26, 2023
2 parents 29cbd58 + 750f4ca commit 3e1e827
Show file tree
Hide file tree
Showing 250 changed files with 182,174 additions and 1,072 deletions.
11 changes: 11 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
# Folder that shoud not be included in the image

.github/*
docker/*
# Documentation
docs/*
# NPM, for debugging only
node_modules/*
# Phive products
.phive/*
tools/*

# phpDocumentor cache
.phpdoc/*

*.md
.dockerignore
.git
.gitignore
# MarkDown and PHP documentation generation
Doxyfile
# Media files for LWT
media/*
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ vendor/

composer.phar

# JS unit testing and documentation
node_modules/

# Editor
Expand All @@ -33,3 +34,11 @@ node_modules/
_*
# For Mac Users
.DS_Store


# Phive products
.phive/*
tools/*

# phpDocumentor cache
.phpdoc/*
11 changes: 7 additions & 4 deletions all_words_wellknown.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
* all_words_wellknown.php?text=[textid]&status=[statusint]
* (mark with a specific status, normally 98 or 99)
*
* PHP version 8.1
*
* @category Helper_Frame
* @package Lwt
* @author LWT Project <[email protected]>
* @license Unlicense <http://unlicense.org/>
Expand Down Expand Up @@ -47,12 +50,12 @@ function all_words_wellknown_get_words($txid)
* @param string $termlc Same as $term, but in lowercase.
* @param int $langid Language ID
*
* @return (int|string)[] Number of rows edited and a javascript query.
* @return array [int, string] Number of rows edited and a javascript query.
*
* @since 2.5.3-fork Do not crash when echoing an error
* @since 2.5.3-fork Do not crash when a word is already registred to the database
*
* @psalm-return array{0: int, 1: string}
* @psalm-return list{int, string}
*/
function all_words_wellknown_process_word($status, $term, $termlc, $langid): array
{
Expand Down Expand Up @@ -109,11 +112,11 @@ function all_words_wellknown_process_word($status, $term, $termlc, $langid): arr
* @param int $txid Text ID
* @param int $status New status to apply to all words.
*
* @return (int|string)[] Number of edited words, and JavaScript query to change their display
* @return array [int, string] Number of edited words, and JavaScript query to change their display
*
* @since 2.5.3-fork Use 'let' instead of 'var' in returned JS
*
* @psalm-return array{0: int, 1: string}
* @psalm-return list{int, string}
*/
function all_words_wellknown_main_loop($txid, $status): array
{
Expand Down
Loading

0 comments on commit 3e1e827

Please sign in to comment.