Code doc with psalm, and manual changes.

psalm configuration was also updated to remove warnings.

do_test_test.php

@@ -81,7 +81,7 @@ function do_test_get_identifier($selection, $sess_testsql, $lang, $text): array
  *
  * @return string SQL projection (selection) string
  */
-function do_test_get_test_sql($selection, $sess_testsql, $lang, $text)
+function do_test_get_test_sql($selection, $sess_testsql, $lang, $text): string
 {
     $identifier = do_test_get_identifier($selection, $sess_testsql, $lang, $text);
     $testsql = do_test_test_get_projection($identifier[0], $identifier[1]);

do_text_text.php

@@ -851,8 +851,9 @@ function do_text_text_content($textid, $only_body = true): void
 }
 
 /*
- * Uncoment to use as a page, deprecated behavior in LWT-fork, will be removed in 3.0.0
-if (isset($_REQUEST['text'])) {
+Uncoment to use as a page, deprecated behavior in LWT-fork, will be removed in 3.0.0
+
+ if (isset($_REQUEST['text'])) {
     do_text_text_content($_REQUEST['text'], false);
 }
 */

edit_archivedtexts.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Manage archived texts
  * 
  * Call: edit_archivedtexts.php?....

edit_languages.php

@@ -369,7 +369,8 @@ function load_language($lgid)
     return $language;
 }
 
-function edit_languages_displayThirdPartyVoiceAPI() {
+function edit_languages_displayThirdPartyVoiceAPI(): void
+{
     ?>
 <h2>Third-Party Voice API</h2>
 <p>

edit_tags.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Manage tags
  * 
  * Call: edit_tags.php?....

edit_texttags.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Manage tags
  * 
  * Call: edit_texttags.php?....

edit_word.php

@@ -179,10 +179,7 @@ function change_term_display($wid, $translation, $hex): void
 }
 
 // INS/UPD
-/*
- * @return void
- */
-function edit_word_do_operation($translation, $fromAnn)
+function edit_word_do_operation($translation, $fromAnn): void
 {
     $hex = null;
     $textlc = trim(prepare_textdata($_REQUEST["WoTextLC"]));

ggl.php

@@ -1,8 +1,7 @@
 <?php
 
-/*
- * \file
- * \brief Google Translate interface
+/**
+ * Google Translate interface
  * 
  * Call: ggl.php?text=[text]&sl=[source language]&tl=[target language] ... translate text
  *     ... sent=[int] ... single sentence mode.
@@ -26,7 +25,7 @@
 
 use function Lwt\Includes\getGoogleTimeToken;
 
-/*
+/**
  * Translate a single sentence using Google Translate.
  * 
  * @param string $text        Text to translate
@@ -46,7 +45,7 @@ function translate_sentence($text, $translation): void
     <?php
 }
 
-/*
+/**
  * Translate input text using Google Translate.
  * 
  * @param string $text   Text to translate
@@ -110,7 +109,7 @@ function translate_term($text, $file, $sl, $tl): void
     <?php
 }
 
-/*
+/**
  * Translate input text using Google Translate.
  * 
  * @param string $text Text to translate
@@ -147,7 +146,7 @@ function translate_text($text, $sl, $tl, $sentence_mode): void
     echo $gglink;
 }
 
-/*
+/**
  * Translate input text using Google Translate.
  * 
  * @param string $text Text to translate

glosbe_api.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Call Glosbe Translation API, analyze and present JSON results
  * for easily filling the "new word form"
  * 

inc/database_connect.php

@@ -1397,8 +1397,6 @@ function (k,v) {
  *
  * @param int[] $wl All the different expression length in the language.
  *
- * @return string SQL-formatted query string
- *
  * @global string $tbpref Database table prefix
  */
 function checkExpressions($wl): void
@@ -1818,7 +1816,7 @@ function update_database($dbname)
 }
 
 
-/*
+/**
  * Add a prefix to table in a SQL query string.
  * 
  * @param string $sql_line SQL string to prefix.
@@ -2160,7 +2158,7 @@ function get_database_prefixes(&$tbpref)
 }
 
 /**
- * @var mysqli $DBCONNECTION Connection to the database
+ * @var \mysqli $DBCONNECTION Connection to the database
  */
 $DBCONNECTION = connect_to_database(
     $server, $userid, $passwd, $dbname, $socket ?? ""

inc/session_utility.php

@@ -726,19 +726,19 @@ function get_selected($value, $selval): string
 
 /**
  * Create a projection operator do perform word test.
- * 
+ *
  * @param string    $key   Type of test. 
  *                         - 'words': selection from words
  *                         - 'texts': selection from texts
  *                         - 'lang': selection from language
  *                         - 'text': selection from single text
  * @param array|int $value Object to select.
- * 
+ *
  * @return string SQL projection necessary
- * 
+ *
  * @global string $tbpref
  */
-function do_test_test_get_projection($key, $value)
+function do_test_test_get_projection($key, $value): string
 {
     global $tbpref;
     $testsql = null;
@@ -2202,7 +2202,7 @@ function textwordcount($textID): void
  *
  * @param int $textid Text ID
  *
- * @return string HTML result
+ * @return int Number of words
  *
  * @global string $tbpref
  */
@@ -2769,11 +2769,11 @@ function getScriptDirectionTag($lid): string
  * @param string|int $lid  Language ID
  * @param int        $len  Number of words in the expression
  *
- * @return (string|int)[] Each found multi-word details
+ * @return (int|string)[][] Each found multi-word details
  *
  * @global string $tbpref Table name prefix
  *
- * @psalm-return list{array<int, string>, list{0?: string,...}}
+ * @psalm-return list{0?: array{SeID: int, TxID: int, position: int, term: string},...}
  */
 function findMecabExpression($text, $lid): array
 {
@@ -2935,9 +2935,11 @@ function insertExpressionFromMeCab($textlc, $lid, $wid, $len, $mode): array
  * @param string     $textlc Text to insert in lower case
  * @param string|int $lid    Language ID
  *
- * @return (string|int)[] Each inserted mutli-word details
+ * @return (int|null|string)[][] Each inserted mutli-word details
  *
  * @global string $tbpref Table name prefix
+ *
+ * @psalm-return list{0?: array{SeID: int, SeTxID: int, position: int, term: null|string, term_display: null|string},...}
  */
 function findStandardExpression($textlc, $lid): array
 {
@@ -3587,12 +3589,12 @@ function create_save_ann($textid): string
 
 /**
  * Truncate the database, remove all data belonging by the current user.
- * 
+ *
  * Keep settings.
- * 
+ *
  * @global $tbpref
  */
-function truncateUserDatabase()
+function truncateUserDatabase(): void
 {
     global $tbpref;
     runsql("TRUNCATE {$tbpref}archivedtexts", '');

inline_edit.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Call: inline_edit.php?...
  *  ...
  * 

install_demo.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Install LWT Demo Database
  * 
  * Call: install_demo.php

new_word.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * New word, created while reading or testing
  * 
  * Call: new_word.php?...

print_text.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Print a text
  * 
  * Call: print_text.php?text=[textid]&...

psalm.xml

@@ -2,6 +2,8 @@
 <psalm
     errorLevel="4"
     resolveFromConfigFile="true"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"

set_word_on_hover.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * PHP version 8.1
  * 
  * @category Helper_Frame

settings.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Preferences / Settings 
  * 
  * Call: settings.php?....

show_word.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Show term
  * 
  * Call: show_word.php?wid=...&ann=...

src/js/audio_controller.js

@@ -4,7 +4,7 @@
  * @license Unlicense
  */
 
-/*
+/**
  * An audio controller.
  */
 const lwt_audio_controller = {

statistics.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Display statistics
  * 
  * Call: statistics.php

table_set_management.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * Analyse DB tables, and manage Table Sets
  * 
  * Call: table_set_management.php