docs: Improved documentation

Author: josantonius

.github/lang/es-ES/README.md

@@ -21,7 +21,7 @@ Biblioteca PHP para la gestión de archivos JSON.
 - [Cómo empezar](#cómo-empezar)
 - [Uso](#uso)
 - [Tests](#tests)
-- [Tareas pendientes](#☑-tareas-pendientes)
+- [Tareas pendientes](#tareas-pendientes)
 - [Registro de cambios](#registro-de-cambios)
 - [Contribuir](#contribuir)
 - [Patrocinar](#patrocinar)
@@ -63,62 +63,54 @@ Métodos disponibles en esta biblioteca:
 ### Obtener el contenido del archivo JSON
 
 ```php
-$json->get();
+$json->get(): array
 ```
 
-**@throws** `CreateDirectoryException` Si no se puede crear el directorio
-
-**@throws** `CreateFileException` Si no se puede crear el archivo
+**@throws** `CreateDirectoryException` si no se puede crear el directorio.
 
-**@throws** `JsonErrorException` Si hay un error al analizar un archivo JSON
+**@throws** `CreateFileException` si no se puede crear el archivo.
 
-**@Return** `array` Contenido del archivo
+**@throws** `JsonErrorException` si hay un error al analizar un archivo JSON.
 
 ### Establecer el contenido del archivo JSON
 
 ```php
-$json->set(array|object $content);
+$json->set(array|object $content): void
 ```
 
-**@throws** `CreateFileException` Si no se puede crear el archivo
-
-**@throws** `JsonErrorException` Si hay un error al analizar un archivo JSON
+**@throws** `CreateFileException` si no se puede crear el archivo.
 
-**@throws** `UnavailableMethodException` Si el método no está disponible
+**@throws** `JsonErrorException` si hay un error al analizar un archivo JSON.
 
-**@Return** `void`
+**@throws** `UnavailableMethodException` si el método no está disponible.
 
 ### Fusionar en el archivo JSON
 
 ```php
-$json->merge(array|object $content);
+$json->merge(array|object $content): array
 ```
 
-**@throws** `CreateFileException` Si no se puede crear el archivo
+**@throws** `CreateFileException` si no se puede crear el archivo.
 
-**@throws** `GetFileException` Si no se puede obtener el archivo
+**@throws** `GetFileException` si no se puede obtener el archivo.
 
-**@throws** `JsonErrorException` Si hay un error al analizar un archivo JSON
+**@throws** `JsonErrorException` si hay un error al analizar un archivo JSON.
 
-**@throws** `UnavailableMethodException` Si el método no está disponible
-
-**@Return** `array` Array resultante
+**@throws** `UnavailableMethodException` si el método no está disponible.
 
 ### Incluir en el archivo JSON
 
 ```php
-$json->push(array|object $content);
+$json->push(array|object $content): array
 ```
 
-**@throws** `CreateFileException` Si no se puede crear el archivo
-
-**@throws** `GetFileException` Si no se puede obtener el archivo
+**@throws** `CreateFileException` si no se puede crear el archivo.
 
-**@throws** `JsonErrorException` Si hay un error al analizar un archivo JSON
+**@throws** `GetFileException` si no se puede obtener el archivo.
 
-**@throws** `UnavailableMethodException` Si el método no está disponible
+**@throws** `JsonErrorException` si hay un error al analizar un archivo JSON.
 
-**@Return** `array` Array resultante
+**@throws** `UnavailableMethodException` si el método no está disponible.
 
 ## Cómo empezar
 
@@ -262,14 +254,14 @@ Ejecutar todas las pruebas anteriores:
 composer tests
 ```
 
-## ☑ Tareas pendientes
+## Tareas pendientes
 
-- [ ] Añadir nueva funcionalidad.
-- [ ] Mejorar pruebas.
-- [ ] Mejorar documentación.
-- [ ] Mejorar la traducción al inglés en el archivo README.
-- [ ] Refactorizar código para las reglas de estilo de código deshabilitadas.
-Ver [phpmd.xml](phpmd.xml) y [phpcs.xml](phpcs.xml).
+- [ ] Añadir nueva funcionalidad
+- [ ] Mejorar pruebas
+- [ ] Mejorar documentación
+- [ ] Mejorar la traducción al inglés en el archivo README
+- [ ] Refactorizar código para las reglas de estilo de código deshabilitadas
+(ver [phpmd.xml](phpmd.xml) y [phpcs.xml](phpcs.xml))
 
 ## Registro de cambios
 

README.md

@@ -21,7 +21,7 @@ PHP simple library for managing JSON files.
 - [Quick Start](#quick-start)
 - [Usage](#usage)
 - [Tests](#tests)
-- [TODO](#-todo)
+- [TODO](#todo)
 - [Changelog](#changelog)
 - [Contribution](#contribution)
 - [Sponsor](#Sponsor)
@@ -63,62 +63,54 @@ Available methods in this library:
 ### Get JSON file contents
 
 ```php
-$json->get();
+$json->get(): array
 ```
 
-**@throws** `CreateDirectoryException` If there is an error when creating a directory
-
-**@throws** `CreateFileException` If there is an error when creating a file
+**@throws** `CreateDirectoryException` if there is an error when creating a directory.
 
-**@throws** `JsonErrorException` If there is an error when parsing a JSON file
+**@throws** `CreateFileException` if there is an error when creating a file.
 
-**@Return** `array` File contents
+**@throws** `JsonErrorException` if there is an error when parsing a JSON file.
 
 ### Set the content of the JSON file
 
 ```php
-$json->set(array|object $content);
+$json->set(array|object $content): void
 ```
 
-**@throws** `CreateFileException` If there is an error when creating a file
-
-**@throws** `JsonErrorException` If there is an error when parsing a JSON file
+**@throws** `CreateFileException` if there is an error when creating a file.
 
-**@throws** `UnavailableMethodException` If the method is not available
+**@throws** `JsonErrorException` if there is an error when parsing a JSON file.
 
-**@Return** `void`
+**@throws** `UnavailableMethodException` if the method is not available.
 
 ### Merge into JSON file
 
 ```php
-$json->merge(array|object $content);
+$json->merge(array|object $content): array
 ```
 
-**@throws** `CreateFileException` If there is an error when creating a file
+**@throws** `CreateFileException` if there is an error when creating a file.
 
-**@throws** `GetFileException` If there is an error when getting a file
+**@throws** `GetFileException` if there is an error when getting a file.
 
-**@throws** `JsonErrorException` If there is an error when parsing a JSON file
+**@throws** `JsonErrorException` if there is an error when parsing a JSON file.
 
-**@throws** `UnavailableMethodException` If the method is not available
-
-**@Return** `array` Resulting array
+**@throws** `UnavailableMethodException` if the method is not available.
 
 ### Push on the JSON file
 
 ```php
-$json->push(array|object $content);
+$json->push(array|object $content): array
 ```
 
-**@throws** `CreateFileException` If there is an error when creating a file
-
-**@throws** `GetFileException` If there is an error when getting a file
+**@throws** `CreateFileException` if there is an error when creating a file.
 
-**@throws** `JsonErrorException` If there is an error when parsing a JSON file
+**@throws** `GetFileException` if there is an error when getting a file.
 
-**@throws** `UnavailableMethodException` If the method is not available
+**@throws** `JsonErrorException` if there is an error when parsing a JSON file.
 
-**@Return** `array` Resulting array
+**@throws** `UnavailableMethodException` if the method is not available.
 
 ## Quick Start
 
@@ -261,13 +253,13 @@ Run all previous tests:
 composer tests
 ```
 
-## ☑ TODO
+## TODO
 
-- [ ] Add new feature.
-- [ ] Improve tests.
-- [ ] Improve documentation.
-- [ ] Improve English translation in the README file.
-- [ ] Refactor code for disabled code style rules. See [phpmd.xml](phpmd.xml) and [phpcs.xml](phpcs.xml).
+- [ ] Add new feature
+- [ ] Improve tests
+- [ ] Improve documentation
+- [ ] Improve English translation in the README file
+- [ ] Refactor code for disabled code style rules (see phpmd.xml and phpcs.xml)
 
 ## Changelog