Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Franck ALARY committed Apr 7, 2022
1 parent a029cd6 commit 80a0d4c
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 35 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ DantSu\FrenchCadastralMapStaticAPI\FrenchCadastralMap is a PHP library created f


* Full name: `\DantSu\FrenchCadastralMapStaticAPI\FrenchCadastralMap`
* Parent class: [OpenStreetMap](../../../classes.md)
* Parent class: [OpenStreetMap](https://github.com/DantSu/php-osm-static-api/blob/master/src/OpenStreetMap.php)

**See Also:**

Expand Down Expand Up @@ -35,7 +35,6 @@ DantSu\FrenchCadastralMapStaticAPI\FrenchCadastralMap is a PHP library created f
- [__construct](#-__construct)
- [setLayers](#-setlayers)
- [setDisplayOpenStreetMap](#-setdisplayopenstreetmap)
- [getMapImage](#-getmapimage)

### ->__construct

Expand Down Expand Up @@ -111,30 +110,8 @@ Display or not OpenStreetMap in background.



---
### ->getMapImage

Get only the map image.









#### Return Value:

**\DantSu\PHPImageEditor\Image** : An instance of DantSu\PHPImageEditor\Image


#### See Also:

* https://github.com/DantSu/php-image-editor - See more about DantSu\PHPImageEditor\Image

---


---
> Automatically generated from source code comments on 2021-09-08 using [phpDocumentor](http://www.phpdoc.org/)
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)
4 changes: 2 additions & 2 deletions docs/classes/DantSu/FrenchCadastralMapStaticAPI/LatLng.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ DantSu\FrenchCadastralMapStaticAPI\LatLng define latitude and longitude for map,
..

* Full name: `\DantSu\FrenchCadastralMapStaticAPI\LatLng`
* Parent class: [LatLng](../../../classes.md)
* Parent class: [LatLng](https://github.com/DantSu/php-osm-static-api/blob/master/src/LatLng.php)

**See Also:**

Expand All @@ -18,4 +18,4 @@ DantSu\FrenchCadastralMapStaticAPI\LatLng define latitude and longitude for map,


---
> Automatically generated from source code comments on 2021-09-08 using [phpDocumentor](http://www.phpdoc.org/)
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)
4 changes: 2 additions & 2 deletions docs/classes/DantSu/FrenchCadastralMapStaticAPI/Line.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ DantSu\FrenchCadastralMapStaticAPI\Line draw line on the map.


* Full name: `\DantSu\FrenchCadastralMapStaticAPI\Line`
* Parent class: [Line](../../../classes.md)
* Parent class: [Line](https://github.com/DantSu/php-osm-static-api/blob/master/src/Line.php)

**See Also:**

Expand All @@ -18,4 +18,4 @@ DantSu\FrenchCadastralMapStaticAPI\Line draw line on the map.


---
> Automatically generated from source code comments on 2021-09-08 using [phpDocumentor](http://www.phpdoc.org/)
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)
4 changes: 2 additions & 2 deletions docs/classes/DantSu/FrenchCadastralMapStaticAPI/Markers.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ DantSu\FrenchCadastralMapStaticAPI\Markers display markers on the map.


* Full name: `\DantSu\FrenchCadastralMapStaticAPI\Markers`
* Parent class: [Markers](../../../classes.md)
* Parent class: [Markers](https://github.com/DantSu/php-osm-static-api/blob/master/src/Markers.php)

**See Also:**

Expand All @@ -18,4 +18,4 @@ DantSu\FrenchCadastralMapStaticAPI\Markers display markers on the map.


---
> Automatically generated from source code comments on 2021-09-08 using [phpDocumentor](http://www.phpdoc.org/)
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)
4 changes: 2 additions & 2 deletions docs/classes/DantSu/FrenchCadastralMapStaticAPI/XY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ DantSu\FrenchCadastralMapStaticAPI\XY define X and Y pixel position for map, lin
..

* Full name: `\DantSu\FrenchCadastralMapStaticAPI\XY`
* Parent class: [XY](../../../classes.md)
* Parent class: [XY](https://github.com/DantSu/php-osm-static-api/blob/master/src/XY.php)

**See Also:**

Expand All @@ -18,4 +18,4 @@ DantSu\FrenchCadastralMapStaticAPI\XY define X and Y pixel position for map, lin


---
> Automatically generated from source code comments on 2021-09-08 using [phpDocumentor](http://www.phpdoc.org/)
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ This is an automatically generated documentation for **PHP OpenStreetMap Static


---
> Automatically generated from source code comments on 2021-09-08 using [phpDocumentor](http://www.phpdoc.org/)
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)
6 changes: 5 additions & 1 deletion src/FrenchCadastralMap.php
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,11 @@ public function setDisplayOpenStreetMap(bool $displayOpenStreetMap): FrenchCadas
return $this;
}

protected function getAttributionText()
/**
* Get attribution text
* @return string Attribution text
*/
protected function getAttributionText(): string
{
return 'cadastre.gouv.fr' . ($this->displayOpenStreetMap ? ' - ' . parent::getAttributionText() : '');
}
Expand Down

0 comments on commit 80a0d4c

Please sign in to comment.