Skip to content

Commit 45e5b07

Browse files
committed
documentation updates
1 parent 5acdd62 commit 45e5b07

File tree

9 files changed

+18
-147
lines changed

9 files changed

+18
-147
lines changed

docs/classes/DantSu/OpenStreetMapStaticAPI/BoundingBox.md

Lines changed: 0 additions & 132 deletions
This file was deleted.

docs/classes/DantSu/OpenStreetMapStaticAPI/LatLng.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ Get longitude
8282

8383

8484
---
85-
> Automatically generated from source code comments on 2022-04-06 using [phpDocumentor](http://www.phpdoc.org/)
85+
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)

docs/classes/DantSu/OpenStreetMapStaticAPI/Line.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@ Draw the line on the map image.
9898

9999

100100
---
101-
> Automatically generated from source code comments on 2022-04-06 using [phpDocumentor](http://www.phpdoc.org/)
101+
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)

docs/classes/DantSu/OpenStreetMapStaticAPI/MapData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,4 +487,4 @@ Convert a latitude and longitude to a XY pixel position in the image
487487

488488

489489
---
490-
> Automatically generated from source code comments on 2022-04-06 using [phpDocumentor](http://www.phpdoc.org/)
490+
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)

docs/classes/DantSu/OpenStreetMapStaticAPI/Markers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,4 +135,4 @@ Draw markers on the image map.
135135

136136

137137
---
138-
> Automatically generated from source code comments on 2022-04-06 using [phpDocumentor](http://www.phpdoc.org/)
138+
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)

docs/classes/DantSu/OpenStreetMapStaticAPI/OpenStreetMap.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Add a line on the map
9797
---
9898
### ->getMapData
9999

100-
Get the bounding box of the map
100+
Get data about the generated map (bounding box, size, OSM tile ids...)
101101

102102

103103

@@ -109,9 +109,12 @@ Get the bounding box of the map
109109

110110
#### Return Value:
111111

112-
**\DantSu\OpenStreetMapStaticAPI\MapData** :
112+
**\DantSu\OpenStreetMapStaticAPI\MapData** : data about the generated map (bounding box, size, OSM tile ids...)
113113

114114

115+
#### See Also:
116+
117+
* https://github.com/DantSu/php-osm-static-api/blob/master/docs/classes/DantSu/OpenStreetMapStaticAPI/MapData.md - See more about MapData
115118

116119
---
117120
### ->getImage
@@ -139,4 +142,4 @@ Get the map image with markers and lines.
139142

140143

141144
---
142-
> Automatically generated from source code comments on 2022-04-06 using [phpDocumentor](http://www.phpdoc.org/)
145+
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)

docs/classes/DantSu/OpenStreetMapStaticAPI/XY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ Get Y
8282

8383

8484
---
85-
> Automatically generated from source code comments on 2022-04-06 using [phpDocumentor](http://www.phpdoc.org/)
85+
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ This is an automatically generated documentation for **PHP OpenStreetMap Static
2424

2525

2626
---
27-
> Automatically generated from source code comments on 2022-04-06 using [phpDocumentor](http://www.phpdoc.org/)
27+
> Automatically generated from source code comments on 2022-04-07 using [phpDocumentor](http://www.phpdoc.org/)

src/OpenStreetMap.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
class OpenStreetMap
1616
{
1717
/**
18-
* @var MapData Bounding box of the map
18+
* @var MapData Data about the generated map (bounding box, size, OSM tile ids...)
1919
*/
2020
protected $mapData;
2121
/**
@@ -63,8 +63,9 @@ public function addLine(Line $line)
6363
}
6464

6565
/**
66-
* Get the bounding box of the map
67-
* @return MapData
66+
* Get data about the generated map (bounding box, size, OSM tile ids...)
67+
* @see https://github.com/DantSu/php-osm-static-api/blob/master/docs/classes/DantSu/OpenStreetMapStaticAPI/MapData.md See more about MapData
68+
* @return MapData data about the generated map (bounding box, size, OSM tile ids...)
6869
*/
6970
public function getMapData(): MapData
7071
{
@@ -73,7 +74,6 @@ public function getMapData(): MapData
7374

7475
/**
7576
* Get only the map image.
76-
*
7777
* @see https://github.com/DantSu/php-image-editor See more about DantSu\PHPImageEditor\Image
7878
* @return Image An instance of DantSu\PHPImageEditor\Image
7979
*/
@@ -100,10 +100,10 @@ protected function getMapImage(): Image
100100
}
101101

102102
/**
103-
* get attribution text
103+
* Get attribution text
104104
* @return string Attribution text
105105
*/
106-
protected function getAttributionText()
106+
protected function getAttributionText(): string
107107
{
108108
return '© OpenStreetMap contributors';
109109
}

0 commit comments

Comments
 (0)