Skip to content

Commit 20dd3ce

Browse files
committed
docs: add functions to document methods
Functions were added to document the methods and avoid confusion. Closes #2
1 parent 960308c commit 20dd3ce

File tree

2 files changed

+21
-37
lines changed

2 files changed

+21
-37
lines changed

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

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -62,56 +62,46 @@ clone https://github.com/josantonius/php-language-code.git
6262

6363
### Clase LanguageCode
6464

65-
```php
66-
use Josantonius\LanguageCode\LanguageCode;
67-
```
68-
69-
Crear objeto:
70-
71-
```php
72-
$languageCode = new LanguageCode();
73-
```
65+
`Josantonius\LanguageCode\LanguageCode`
7466

7567
Obtener array con todos los códigos de idioma:
7668

7769
```php
78-
$languageCode->all(): array
70+
public static function all(): array
7971
```
8072

8173
Obtener código de idioma desde el nombre del idioma:
8274

8375
```php
84-
$languageCode->getCode(string $languageName): string|null
76+
public static function getCode(string $languageName): string|null
8577
```
8678

8779
Obtener el nombre del idioma desde código de idioma:
8880

8981
```php
90-
$languageCode->getName(string $languageCode): string|null
82+
public static function getName(string $languageCode): string|null
9183
```
9284

9385
### Clase LanguageCodeCollection
9486

95-
```php
96-
use Josantonius\LanguageCode\LanguageCodeCollection;
97-
```
87+
`Josantonius\LanguageCode\LanguageCodeCollection`
9888

9989
Obtener array con todos los códigos de idioma:
10090

10191
```php
102-
LanguageCodeCollection::all(): array
92+
public static function all(): array
10393
```
10494

10595
Obtener código de idioma desde el nombre del idioma:
10696

10797
```php
108-
LanguageCodeCollection::getCode(string $languageName): string|null
98+
public static function getCode(string $languageName): string|null
10999
```
110100

111101
Obtener el nombre del idioma desde código de idioma:
112102

113103
```php
114-
LanguageCodeCollection::getName(string $languageCode): string|null
104+
public static function getName(string $languageCode): string|null
115105
```
116106

117107
## Uso
@@ -184,6 +174,10 @@ use Josantonius\LanguageCode\LanguageCodeCollection;
184174
LanguageCodeCollection::getName('de'); // German
185175
```
186176

177+
## Listado en formato JSON
178+
179+
[Ir al recurso](https://gist.github.com/josantonius/b455e315bc7f790d14b136d61d9ae469).
180+
187181
## Tests
188182

189183
Para ejecutar las [pruebas](tests) necesitarás [Composer](http://getcomposer.org/download/)

README.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ PHP library to get language name from code.
2626
- [TODO](#todo)
2727
- [Changelog](#changelog)
2828
- [Contribution](#contribution)
29-
- [Sponsor](#Sponsor)
29+
- [Sponsor](#sponsor)
3030
- [License](#license)
3131

3232
---
@@ -62,56 +62,46 @@ clone https://github.com/josantonius/php-language-code.git
6262

6363
### LanguageCode Class
6464

65-
```php
66-
use Josantonius\LanguageCode\LanguageCode;
67-
```
68-
69-
Create object:
70-
71-
```php
72-
$languageCode = new LanguageCode();
73-
```
65+
`Josantonius\LanguageCode\LanguageCode`
7466

7567
Get all language codes as array:
7668

7769
```php
78-
$languageCode->all(): array
70+
public static function all(): array;
7971
```
8072

8173
Get language code from language name:
8274

8375
```php
84-
$languageCode->getCode(string $languageName): string|null
76+
public static function getCode(string $languageName): string|null;
8577
```
8678

8779
Get language name from language code:
8880

8981
```php
90-
$languageCode->getName(string $languageCode): string|null
82+
public static function getName(string $languageCode): string|null;
9183
```
9284

9385
### LanguageCodeCollection Class
9486

95-
```php
96-
use Josantonius\LanguageCode\LanguageCodeCollection;
97-
```
87+
`Josantonius\LanguageCode\LanguageCodeCollection`
9888

9989
Get all language codes as array:
10090

10191
```php
102-
LanguageCodeCollection::all(): array
92+
public static function all(): array
10393
```
10494

10595
Get language code from language name:
10696

10797
```php
108-
LanguageCodeCollection::getCode(string $languageName): string|null
98+
public static function getCode(string $languageName): string|null
10999
```
110100

111101
Get language name from language code:
112102

113103
```php
114-
LanguageCodeCollection::getName(string $languageCode): string|null
104+
public static function getName(string $languageCode): string|null
115105
```
116106

117107
## Usage

0 commit comments

Comments
 (0)