docs: add functions to document methods

josantonius · josantonius · commit af7036a6228b · 2022-08-27T23:37:48.000+02:00
Functions were added to document the methods and avoid confusion. Closes #3
diff --git a/.github/lang/es-ES/README.md b/.github/lang/es-ES/README.md
@@ -17,13 +17,13 @@ Biblioteca de PHP para obtener mensajes y definiciones de códigos de estado HTT
 
 - [Requisitos](#requisitos)
 - [Instalación](#instalación)
-- [Available Classes](#available-classes)
+- [Clases disponibles](#clases-disponibles)
   - [Clase HttpStatusCode](#clase-httpstatuscode)
 - [Excepciones utilizadas](#excepciones-utilizadas)
 - [Uso](#uso)
 - [Listado en formato JSON](#listado-en-formato-json)
 - [Tests](#tests)
-- [Tareas pendientes](#-tareas-pendientes)
+- [Tareas pendientes](#tareas-pendientes)
 - [Registro de Cambios](#registro-de-cambios)
 - [Contribuir](#contribuir)
 - [Patrocinar](#patrocinar)
@@ -62,9 +62,7 @@ git clone https://github.com/josantonius/http-status-code.git
 
 ### Clase HttpStatusCode
 
-```php
-use Josantonius\HttpStatusCode\HttpStatusCode;
-```
+`Josantonius\HttpStatusCode\HttpStatusCode`
 
 Crear una nueva instancia que defina el idioma:
 
@@ -77,37 +75,37 @@ Crear una nueva instancia que defina el idioma:
  * 
  * @throws UnsupportedLanguageException if language is not supported.
  */
-$httpStatusCode = new HttpStatusCode(string $language = 'en');
+public function __construct(string $language = 'en');
 ```
 
 Obtiene el mensaje de un código de estado HTTP:
 
 ```php
-$httpStatusCode->getMessage(int $code): string|null
+public function getMessage(int $code): string|null;
 ```
 
 Obtiene los mensajes de todos los códigos de estado HTTP:
 
 ```php
-$httpStatusCode->getMessages(): array
+public function getMessages(): array;
 ```
 
 Obtiene la definición de un código de estado HTTP:
 
 ```php
-$httpStatusCode->getDefinition(int $code): string|null
+public function getDefinition(int $code): string|null;
 ```
 
 Obtiene las definiciones de todos los códigos de estado HTTP:
 
 ```php
-$httpStatusCode->getDefinitions(): array
+public function getDefinitions(): array;
 ```
 
 Obtiene mensajes y definiciones de todos los códigos de estado HTTP:
 
 ```php
-$httpStatusCode->getAll(): array
+public function getAll(): array;
 ```
 
 ## Excepciones utilizadas
@@ -123,10 +121,14 @@ Ejemplo de uso para esta biblioteca:
 ### Crear una nueva instancia que defina el idioma
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
 $httpStatusCode = new HttpStatusCode();     // Obtiene los mensajes en inglés.
 ```
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
 $httpStatusCode = new HttpStatusCode('es'); // Obtiene los mensajes en español.
 ```
 
@@ -235,9 +237,9 @@ $httpStatusCode->getAll();
 ]
 ```
 
-## List in Json format
+## Listado en formato JSON
 
-[Go to the resource](https://gist.github.com/Josantonius/b455e315bc7f790d14b136d61d9ae469).
+[Ir al recurso](https://gist.github.com/Josantonius/b455e315bc7f790d14b136d61d9ae469).
 
 ## Tests
 
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ PHP library to get HTTP status code messages and definitions.
 - [TODO](#todo)
 - [Changelog](#changelog)
 - [Contribution](#contribution)
-- [Sponsor](#Sponsor)
+- [Sponsor](#sponsor)
 - [License](#license)
 
 ---
@@ -62,9 +62,7 @@ git clone https://github.com/josantonius/http-status-code.git
 
 ### HttpStatusCode Class
 
-```php
-use Josantonius\HttpStatusCode\HttpStatusCode;
-```
+`Josantonius\HttpStatusCode\HttpStatusCode`
 
 Create a new instance defining the language:
 
@@ -77,37 +75,37 @@ Create a new instance defining the language:
  * 
  * @throws UnsupportedLanguageException if language is not supported.
  */
-$httpStatusCode = new HttpStatusCode(string $language = 'en');
+public function __construct(string $language = 'en');
 ```
 
 Gets message of an HTTP status code:
 
 ```php
-$httpStatusCode->getMessage(int $code): string|null
+public function getMessage(int $code): string|null;
 ```
 
 Gets the messages of all HTTP status codes:
 
 ```php
-$httpStatusCode->getMessages(): array
+public function getMessages(): array;
 ```
 
 Gets definition of an HTTP status code:
 
 ```php
-$httpStatusCode->getDefinition(int $code): string|null
+public function getDefinition(int $code): string|null;
 ```
 
 Gets the definitions of all HTTP status codes:
 
 ```php
-$httpStatusCode->getDefinitions(): array
+public function getDefinitions(): array;
 ```
 
 Gets messages and definitions of all HTTP status codes:
 
 ```php
-$httpStatusCode->getAll(): array
+public function getAll(): array;
 ```
 
 ## Exceptions Used
@@ -129,6 +127,8 @@ $httpStatusCode = new HttpStatusCode();     // Gets the messages in English.
 ```
 
 ```php
+use Josantonius\HttpStatusCode\HttpStatusCode;
+
 $httpStatusCode = new HttpStatusCode('es'); // Gets the messages in Spanish.
 ```
 
