chore: fix wordset docstrings

monero-integrations · Jun 2, 2024 · 54f8d73 · 54f8d73
1 parent f0a0e6a
commit 54f8d73
Show file tree

Hide file tree

Showing 13 changed files with 117 additions and 52 deletions.
diff --git a/src/wordsets/chinese_simplified.ws.php b/src/wordsets/chinese_simplified.ws.php
@@ -8,7 +8,8 @@
 
 class chinese_simplified implements Wordset
 {
-    /* Returns name of wordset in the wordset's native language.
+    /**
+     * Returns name of wordset in the wordset's native language.
      * This is a human-readable string, and should be capitalized
      * if the language supports it.
      */
@@ -17,15 +18,17 @@ public static function name(): string
         return "简体中文 (中国)";
     }
 
-    /* Returns name of wordset in english.
+    /**
+     * Returns name of wordset in English.
      * This is a human-readable string, and should be capitalized
      */
     public static function englishName(): string
     {
         return "Chinese (simplified)";
     }
 
-    /* Returns integer indicating length of unique prefix,
+    /**
+     * Returns integer indicating length of unique prefix,
      * such that each prefix of this length is unique across
      * the entire set of words.
      *
@@ -37,7 +40,9 @@ public static function prefixLength(): int
         return 1;  // first letter of each word in wordset is unique.
     }
 
-    /* Returns an array of all words in the wordset.
+    /**
+     * Returns an array of all words in the wordset.
+     * @return array<string>
      */
     public static function words(): array
     {

diff --git a/src/wordsets/dutch.ws.php b/src/wordsets/dutch.ws.php
@@ -8,7 +8,8 @@
 
 class dutch implements Wordset
 {
-    /* Returns name of wordset in the wordset's native language.
+    /**
+     * Returns name of wordset in the wordset's native language.
      * This is a human-readable string, and should be capitalized
      * if the language supports it.
      */
@@ -17,15 +18,17 @@ public static function name(): string
         return "Nederlands";
     }
 
-    /* Returns name of wordset in english.
+    /**
+     * Returns name of wordset in English.
      * This is a human-readable string, and should be capitalized
      */
     public static function englishName(): string
     {
         return "Dutch";
     }
 
-    /* Returns integer indicating length of unique prefix,
+    /**
+     * Returns integer indicating length of unique prefix,
      * such that each prefix of this length is unique across
      * the entire set of words.
      *
@@ -37,7 +40,9 @@ public static function prefixLength(): int
         return 4;  // first 4 letters of each word in wordset is unique.
     }
 
-    /* Returns an array of all words in the wordset.
+    /**
+     * Returns an array of all words in the wordset.
+     * @return array<string>
      */
     public static function words(): array
     {

diff --git a/src/wordsets/english.ws.php b/src/wordsets/english.ws.php
@@ -8,7 +8,8 @@
 
 class english implements Wordset
 {
-    /* Returns name of wordset in the wordset's native language.
+    /**
+     * Returns name of wordset in the wordset's native language.
      * This is a human-readable string, and should be capitalized
      * if the language supports it.
      */
@@ -17,15 +18,17 @@ public static function name(): string
         return "English";
     }
 
-    /* Returns name of wordset in english.
+    /**
+     * Returns name of wordset in English.
      * This is a human-readable string, and should be capitalized
      */
     public static function englishName(): string
     {
         return "English";
     }
 
-    /* Returns integer indicating length of unique prefix,
+    /**
+     * Returns integer indicating length of unique prefix,
      * such that each prefix of this length is unique across
      * the entire set of words.
      *
@@ -37,7 +40,9 @@ public static function prefixLength(): int
         return 3;  // first 3 letters of each word in wordset is unique.
     }
 
-    /* Returns an array of all words in the wordset.
+    /**
+     * Returns an array of all words in the wordset.
+     * @return array<string>
      */
     public static function words(): array
     {

diff --git a/src/wordsets/english_old.ws.php b/src/wordsets/english_old.ws.php
@@ -13,7 +13,8 @@
 
 class english_old implements Wordset
 {
-    /* Returns name of wordset in the wordset's native language.
+    /**
+     * Returns name of wordset in the wordset's native language.
      * This is a human-readable string, and should be capitalized
      * if the language supports it.
      */
@@ -22,15 +23,17 @@ public static function name(): string
         return "EnglishOld";
     }
 
-    /* Returns name of wordset in english.
+    /**
+     * Returns name of wordset in English.
      * This is a human-readable string, and should be capitalized
      */
     public static function englishName(): string
     {
         return "English (old)";
     }
 
-    /* Returns integer indicating length of unique prefix,
+    /**
+     * Returns integer indicating length of unique prefix,
      * such that each prefix of this length is unique across
      * the entire set of words.
      *
@@ -42,7 +45,9 @@ public static function prefixLength(): int
         return 0;  // require entire word.
     }
 
-    /* Returns an array of all words in the wordset.
+    /**
+     * Returns an array of all words in the wordset.
+     * @return array<string>
      */
     public static function words(): array
     {

diff --git a/src/wordsets/esperanto.ws.php b/src/wordsets/esperanto.ws.php
@@ -8,7 +8,8 @@
 
 class esperanto implements Wordset
 {
-    /* Returns name of wordset in the wordset's native language.
+    /**
+     * Returns name of wordset in the wordset's native language.
      * This is a human-readable string, and should be capitalized
      * if the language supports it.
      */
@@ -17,15 +18,17 @@ public static function name(): string
         return "Esperanto";
     }
 
-    /* Returns name of wordset in english.
+    /**
+     * Returns name of wordset in English.
      * This is a human-readable string, and should be capitalized
      */
     public static function englishName(): string
     {
         return "Esperanto";
     }
 
-    /* Returns integer indicating length of unique prefix,
+    /**
+     * Returns integer indicating length of unique prefix,
      * such that each prefix of this length is unique across
      * the entire set of words.
      *
@@ -37,7 +40,9 @@ public static function prefixLength(): int
         return 4;  // first 4 letters of each word in wordset is unique.
     }
 
-    /* Returns an array of all words in the wordset.
+    /**
+     * Returns an array of all words in the wordset.
+     * @return array<string>
      */
     public static function words(): array
     {

diff --git a/src/wordsets/french.ws.php b/src/wordsets/french.ws.php
@@ -8,7 +8,8 @@
 
 class french implements Wordset
 {
-    /* Returns name of wordset in the wordset's native language.
+    /**
+     * Returns name of wordset in the wordset's native language.
      * This is a human-readable string, and should be capitalized
      * if the language supports it.
      */
@@ -17,15 +18,17 @@ public static function name(): string
         return "Français";
     }
 
-    /* Returns name of wordset in english.
+    /**
+     * Returns name of wordset in English.
      * This is a human-readable string, and should be capitalized
      */
     public static function englishName(): string
     {
         return "French";
     }
 
-    /* Returns integer indicating length of unique prefix,
+    /**
+     * Returns integer indicating length of unique prefix,
      * such that each prefix of this length is unique across
      * the entire set of words.
      *
@@ -37,7 +40,9 @@ public static function prefixLength(): int
         return 4;  // first 4 letters of each word in wordset is unique.
     }
 
-    /* Returns an array of all words in the wordset.
+    /**
+     * Returns an array of all words in the wordset.
+     * @return array<string>
      */
     public static function words(): array
     {

diff --git a/src/wordsets/german.ws.php b/src/wordsets/german.ws.php
@@ -8,7 +8,8 @@
 
 class german implements Wordset
 {
-    /* Returns name of wordset in the wordset's native language.
+    /**
+     * Returns name of wordset in the wordset's native language.
      * This is a human-readable string, and should be capitalized
      * if the language supports it.
      */
@@ -17,7 +18,8 @@ public static function name(): string
         return "Deutsch";
     }
 
-    /* Returns name of wordset in english.
+    /**
+     * Returns name of wordset in English.
      * This is a human-readable string, and should be capitalized
      */
     public static function englishName(): string
@@ -26,7 +28,8 @@ public static function englishName(): string
     }
 
 
-    /* Returns integer indicating length of unique prefix,
+    /**
+     * Returns integer indicating length of unique prefix,
      * such that each prefix of this length is unique across
      * the entire set of words.
      *
@@ -38,7 +41,9 @@ public static function prefixLength(): int
         return 4;  // first 4 letters of each word in wordset is unique.
     }
 
-    /* Returns an array of all words in the wordset.
+    /**
+     * Returns an array of all words in the wordset.
+     * @return array<string>
      */
     public static function words(): array
     {

diff --git a/src/wordsets/italian.ws.php b/src/wordsets/italian.ws.php
@@ -8,7 +8,8 @@
 
 class italian implements Wordset
 {
-    /* Returns name of wordset in the wordset's native language.
+    /**
+     * Returns name of wordset in the wordset's native language.
      * This is a human-readable string, and should be capitalized
      * if the language supports it.
      */
@@ -17,15 +18,17 @@ public static function name(): string
         return "Italiano";
     }
 
-    /* Returns name of wordset in english.
+    /**
+     * Returns name of wordset in English.
      * This is a human-readable string, and should be capitalized
      */
     public static function englishName(): string
     {
         return "Italian";
     }
 
-    /* Returns integer indicating length of unique prefix,
+    /**
+     * Returns integer indicating length of unique prefix,
      * such that each prefix of this length is unique across
      * the entire set of words.
      *
@@ -37,7 +40,9 @@ public static function prefixLength(): int
         return 4;  // first 4 letters of each word in wordset is unique.
     }
 
-    /* Returns an array of all words in the wordset.
+    /**
+     * Returns an array of all words in the wordset.
+     * @return array<string>
      */
     public static function words(): array
     {

diff --git a/src/wordsets/japanese.ws.php b/src/wordsets/japanese.ws.php
@@ -8,7 +8,8 @@
 
 class japanese implements Wordset
 {
-    /* Returns name of wordset in the wordset's native language.
+    /**
+     * Returns name of wordset in the wordset's native language.
      * This is a human-readable string, and should be capitalized
      * if the language supports it.
      */
@@ -17,15 +18,17 @@ public static function name(): string
         return "日本語";
     }
 
-    /* Returns name of wordset in english.
+    /**
+     * Returns name of wordset in English.
      * This is a human-readable string, and should be capitalized
      */
     public static function englishName(): string
     {
         return "Japanese";
     }
 
-    /* Returns integer indicating length of unique prefix,
+    /**
+     * Returns integer indicating length of unique prefix,
      * such that each prefix of this length is unique across
      * the entire set of words.
      *
@@ -37,7 +40,9 @@ public static function prefixLength(): int
         return 3;  // first 3 letters of each word in wordset is unique.
     }
 
-    /* Returns an array of all words in the wordset.
+    /**
+     * Returns an array of all words in the wordset.
+     * @return array<string>
      */
     public static function words(): array
     {