chore: update example for phpHeaderDoc

paul-thebaud · Dec 17, 2023 · a7d6fa3 · a7d6fa3
1 parent 92a0723
commit a7d6fa3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/public/docs-content/en/configuration.md b/public/docs-content/en/configuration.md
@@ -154,13 +154,13 @@ in the test class ("license" for example).
 * **Parameter Key** : `phpHeaderDoc`
 * **Type** : `string`
 * **Default value**: `'''`
-* **Description** : Defines the PHPDoc header to prepend to the test class.
-  Example :
-  ```php
-  /*
-   * @license MIT
-   */
-  ```
+* **Description** : Defines the PHPDoc header to prepend to the test class. Example :
+
+```php
+return [
+    'phpHeaderDoc' => "/*\n * @license MIT\n */",
+];
+```
 
 ### Options
 

diff --git a/public/docs-content/fr/configuration.md b/public/docs-content/fr/configuration.md
@@ -154,13 +154,13 @@ dans la classe de test ("license" par exemple).
 * **Clé du paramètre** : `phpHeaderDoc`
 * **Type** : `string`
 * **Valeur par défaut**: `'''`
-* **Description** : Définit l'annotation PHPDoc qui doivent être ajoutées en entête dans la classe de test.
-  Exemple :
-  ```php
-  /*
-   * @license MIT
-   */
-  ```
+* **Description** : Définit l'annotation PHPDoc qui doivent être ajoutées en entête dans la classe de test. Exemple :
+
+```php
+return [
+    'phpHeaderDoc' => "/*\n * @license MIT\n */",
+];
+```
 
 ### Options