From 80a0d4ce11951e3cd6fc955b008cf30d10a71e1c Mon Sep 17 00:00:00 2001 From: Franck ALARY Date: Thu, 7 Apr 2022 09:54:44 +0200 Subject: [PATCH] Documentation updates --- .../FrenchCadastralMap.md | 27 ++----------------- .../FrenchCadastralMapStaticAPI/LatLng.md | 4 +-- .../FrenchCadastralMapStaticAPI/Line.md | 4 +-- .../FrenchCadastralMapStaticAPI/Markers.md | 4 +-- .../DantSu/FrenchCadastralMapStaticAPI/XY.md | 4 +-- docs/index.md | 2 +- src/FrenchCadastralMap.php | 6 ++++- 7 files changed, 16 insertions(+), 35 deletions(-) diff --git a/docs/classes/DantSu/FrenchCadastralMapStaticAPI/FrenchCadastralMap.md b/docs/classes/DantSu/FrenchCadastralMapStaticAPI/FrenchCadastralMap.md index f12d331..33ee6b7 100644 --- a/docs/classes/DantSu/FrenchCadastralMapStaticAPI/FrenchCadastralMap.md +++ b/docs/classes/DantSu/FrenchCadastralMapStaticAPI/FrenchCadastralMap.md @@ -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:** @@ -35,7 +35,6 @@ DantSu\FrenchCadastralMapStaticAPI\FrenchCadastralMap is a PHP library created f - [__construct](#-__construct) - [setLayers](#-setlayers) - [setDisplayOpenStreetMap](#-setdisplayopenstreetmap) -- [getMapImage](#-getmapimage) ### ->__construct @@ -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/) diff --git a/docs/classes/DantSu/FrenchCadastralMapStaticAPI/LatLng.md b/docs/classes/DantSu/FrenchCadastralMapStaticAPI/LatLng.md index 74859e7..8467b80 100644 --- a/docs/classes/DantSu/FrenchCadastralMapStaticAPI/LatLng.md +++ b/docs/classes/DantSu/FrenchCadastralMapStaticAPI/LatLng.md @@ -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:** @@ -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/) diff --git a/docs/classes/DantSu/FrenchCadastralMapStaticAPI/Line.md b/docs/classes/DantSu/FrenchCadastralMapStaticAPI/Line.md index a472146..f4b5587 100644 --- a/docs/classes/DantSu/FrenchCadastralMapStaticAPI/Line.md +++ b/docs/classes/DantSu/FrenchCadastralMapStaticAPI/Line.md @@ -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:** @@ -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/) diff --git a/docs/classes/DantSu/FrenchCadastralMapStaticAPI/Markers.md b/docs/classes/DantSu/FrenchCadastralMapStaticAPI/Markers.md index 9c6ec93..efc4bf3 100644 --- a/docs/classes/DantSu/FrenchCadastralMapStaticAPI/Markers.md +++ b/docs/classes/DantSu/FrenchCadastralMapStaticAPI/Markers.md @@ -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:** @@ -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/) diff --git a/docs/classes/DantSu/FrenchCadastralMapStaticAPI/XY.md b/docs/classes/DantSu/FrenchCadastralMapStaticAPI/XY.md index 80fc08a..643587e 100644 --- a/docs/classes/DantSu/FrenchCadastralMapStaticAPI/XY.md +++ b/docs/classes/DantSu/FrenchCadastralMapStaticAPI/XY.md @@ -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:** @@ -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/) diff --git a/docs/index.md b/docs/index.md index 41d906f..3160f54 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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/) diff --git a/src/FrenchCadastralMap.php b/src/FrenchCadastralMap.php index f3cade6..b9b8a63 100644 --- a/src/FrenchCadastralMap.php +++ b/src/FrenchCadastralMap.php @@ -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() : ''); }