Update API documentation.

garrettrayj · May 4, 2019 · 65e9a89 · 65e9a89
1 parent f1ed4a2
commit 65e9a89
Show file tree

Hide file tree

Showing 14 changed files with 229 additions and 157 deletions.
diff --git a/README.md b/README.md
@@ -89,7 +89,7 @@ available objects and methods.
 Dev Container
 -------------
 
-The included Dockerfile builds an image with all the dependencies need for extension development and testing, including testing for memory leaks.
+The included Dockerfile builds an image with all the dependencies needed for extension development and testing, including testing for memory leaks.
 
     docker build -t php7-mapnik-dev .
     docker run -it --mount type=bind,source=$(pwd),target=/opt/php7-mapnik php7-mapnik-dev:latest
diff --git a/docs/api/Mapnik.html b/docs/api/Mapnik.html
@@ -66,8 +66,7 @@
                 <div class="namespace-breadcrumbs">
         <ol class="breadcrumb">
             <li><span class="label label-default">Namespace</span></li>
-                                                        <li><a href="Mapnik.html">Mapnik</a></li>
-
+                    <li><a href="Mapnik.html">Mapnik</a></li><li class="backslash">\</li>
         </ol>
     </div>
             <div id="page-content">
@@ -86,7 +85,7 @@ <h2>Classes</h2>
 
                 </div>
                 <div class="col-md-6">
-                    Class AggRenderer
+
                 </div>
             </div>
                     <div class="row">
@@ -95,7 +94,7 @@ <h2>Classes</h2>
 
                 </div>
                 <div class="col-md-6">
-                    Class Box2D
+
                 </div>
             </div>
                     <div class="row">
@@ -104,7 +103,7 @@ <h2>Classes</h2>
 
                 </div>
                 <div class="col-md-6">
-                    Class DatasourceCache
+
                 </div>
             </div>
                     <div class="row">
@@ -113,7 +112,7 @@ <h2>Classes</h2>
 
                 </div>
                 <div class="col-md-6">
-                    Class Image
+
                 </div>
             </div>
                     <div class="row">
@@ -122,7 +121,7 @@ <h2>Classes</h2>
 
                 </div>
                 <div class="col-md-6">
-                    Class Map
+
                 </div>
             </div>
                     <div class="row">
@@ -131,7 +130,7 @@ <h2>Classes</h2>
 
                 </div>
                 <div class="col-md-6">
-                    Class ProjTransform
+                    Re-project Box2D objects.
                 </div>
             </div>
                     <div class="row">
@@ -140,7 +139,7 @@ <h2>Classes</h2>
 
                 </div>
                 <div class="col-md-6">
-                    Class Projection
+                    Represents a spatial reference system. Used in conjunction with ProjTransform to project bounding boxes.
                 </div>
             </div>
             </div>
@@ -155,7 +154,7 @@ <h2>Exceptions</h2>
 
                 </div>
                 <div class="col-md-6">
-                    Class Exception
+
                 </div>
             </div>
             </div>

diff --git a/docs/api/Mapnik/AggRenderer.html b/docs/api/Mapnik/AggRenderer.html
@@ -66,9 +66,7 @@
                         <div class="namespace-breadcrumbs">
             <ol class="breadcrumb">
                 <li><span class="label label-default">class</span></li>
-                                                            <li><a href="../Mapnik.html">Mapnik</a></li>
-
-                <li>AggRenderer</li>
+                        <li><a href="../Mapnik.html">Mapnik</a></li><li class="backslash">\</li><li>AggRenderer</li>
             </ol>
         </div>
                 <div id="page-content">
@@ -132,7 +130,7 @@ <h3 id="method___construct">
 
 
                     <div class="method-description">
-                                    <p>AggRenderer constructor.</p>                                </div>
+                                    <p>AggRenderer constructor.</p>                                                </div>
                 <div class="tags">
                             <h4>Parameters</h4>
 
@@ -168,7 +166,7 @@ <h3 id="method_apply">
 
 
                     <div class="method-description">
-                                    <p>Render/paint image from Map configuration.</p>                                </div>
+                                    <p>Render/paint image from Map configuration.</p>                                                </div>
                 <div class="tags">
 
 

diff --git a/docs/api/Mapnik/Box2D.html b/docs/api/Mapnik/Box2D.html
@@ -66,9 +66,7 @@
                         <div class="namespace-breadcrumbs">
             <ol class="breadcrumb">
                 <li><span class="label label-default">class</span></li>
-                                                            <li><a href="../Mapnik.html">Mapnik</a></li>
-
-                <li>Box2D</li>
+                        <li><a href="../Mapnik.html">Mapnik</a></li><li class="backslash">\</li><li>Box2D</li>
             </ol>
         </div>
                 <div id="page-content">
@@ -162,7 +160,7 @@ <h3 id="method___construct">
 
 
                     <div class="method-description">
-                                    <p>Box2D constructor.</p>                                </div>
+                                    <p>Box2D constructor.</p>                                                </div>
                 <div class="tags">
                             <h4>Parameters</h4>
 
@@ -208,7 +206,7 @@ <h3 id="method_minX">
 
 
                     <div class="method-description">
-                                    <p>Get east boundary of envelope.</p>                                </div>
+                                    <p>Get east boundary of envelope.</p>                                                </div>
                 <div class="tags">
 
                             <h4>Return Value</h4>
@@ -238,7 +236,7 @@ <h3 id="method_minY">
 
 
                     <div class="method-description">
-                                    <p>Get north boundary of envelope.</p>                                </div>
+                                    <p>Get north boundary of envelope.</p>                                                </div>
                 <div class="tags">
 
                             <h4>Return Value</h4>
@@ -268,7 +266,7 @@ <h3 id="method_maxX">
 
 
                     <div class="method-description">
-                                    <p>Get west boundary of envelope.</p>                                </div>
+                                    <p>Get west boundary of envelope.</p>                                                </div>
                 <div class="tags">
 
                             <h4>Return Value</h4>
@@ -298,7 +296,7 @@ <h3 id="method_maxY">
 
 
                     <div class="method-description">
-                                    <p>Get south boundary of envelope.</p>                                </div>
+                                    <p>Get south boundary of envelope.</p>                                                </div>
                 <div class="tags">
 
                             <h4>Return Value</h4>

diff --git a/docs/api/Mapnik/DatasourceCache.html b/docs/api/Mapnik/DatasourceCache.html
@@ -66,9 +66,7 @@
                         <div class="namespace-breadcrumbs">
             <ol class="breadcrumb">
                 <li><span class="label label-default">class</span></li>
-                                                            <li><a href="../Mapnik.html">Mapnik</a></li>
-
-                <li>DatasourceCache</li>
+                        <li><a href="../Mapnik.html">Mapnik</a></li><li class="backslash">\</li><li>DatasourceCache</li>
             </ol>
         </div>
                 <div id="page-content">
@@ -132,7 +130,7 @@ <h3 id="method_registerDatasources">
 
 
                     <div class="method-description">
-                                    <p>Register datasource input plugins.</p>                                </div>
+                                    <p>Register datasource input plugins.</p>                                                </div>
                 <div class="tags">
                             <h4>Parameters</h4>
 
@@ -163,7 +161,7 @@ <h3 id="method_getPluginNames">
 
 
                     <div class="method-description">
-                                    <p>Get array of registered input plugins.</p>                                </div>
+                                    <p>Get array of registered input plugins.</p>                                                </div>
                 <div class="tags">
 
                             <h4>Return Value</h4>

diff --git a/docs/api/Mapnik/Exception.html b/docs/api/Mapnik/Exception.html
@@ -66,9 +66,7 @@
                         <div class="namespace-breadcrumbs">
             <ol class="breadcrumb">
                 <li><span class="label label-default">class</span></li>
-                                                            <li><a href="../Mapnik.html">Mapnik</a></li>
-
-                <li>Exception</li>
+                        <li><a href="../Mapnik.html">Mapnik</a></li><li class="backslash">\</li><li>Exception</li>
             </ol>
         </div>
                 <div id="page-content">

diff --git a/docs/api/Mapnik/Image.html b/docs/api/Mapnik/Image.html
@@ -66,9 +66,7 @@
                         <div class="namespace-breadcrumbs">
             <ol class="breadcrumb">
                 <li><span class="label label-default">class</span></li>
-                                                            <li><a href="../Mapnik.html">Mapnik</a></li>
-
-                <li>Image</li>
+                        <li><a href="../Mapnik.html">Mapnik</a></li><li class="backslash">\</li><li>Image</li>
             </ol>
         </div>
                 <div id="page-content">
@@ -142,7 +140,7 @@ <h3 id="method___construct">
 
 
                     <div class="method-description">
-                                    <p>Image constructor.</p>                                </div>
+                                    <p>Image constructor.</p>                                                </div>
                 <div class="tags">
                             <h4>Parameters</h4>
 
@@ -178,7 +176,7 @@ <h3 id="method_saveToFile">
 
 
                     <div class="method-description">
-                                    <p>Save image to a file.</p>                                </div>
+                                    <p>Save image to a file.</p>                                                </div>
                 <div class="tags">
                             <h4>Parameters</h4>
 
@@ -202,7 +200,9 @@ <h4>See also</h4>
 
                     <table class="table table-condensed">
                     <tr>
-                <td>https://github.com/mapnik/mapnik/wiki/Image-IO</td>
+                <td>
+                                            <a href="https://github.com/mapnik/mapnik/wiki/Image-IO">https://github.com/mapnik/mapnik/wiki/Image-IO</a>
+                                    </td>
                 <td>Mapnik image formats documentation</td>
             </tr>
             </table>
@@ -223,7 +223,7 @@ <h3 id="method_saveToString">
 
 
                     <div class="method-description">
-                                    <p>Save image to a string.</p>                                </div>
+                                    <p>Save image to a string.</p>                                                </div>
                 <div class="tags">
                             <h4>Parameters</h4>
 
@@ -251,7 +251,9 @@ <h4>See also</h4>
 
                     <table class="table table-condensed">
                     <tr>
-                <td>https://github.com/mapnik/mapnik/wiki/Image-IO</td>
+                <td>
+                                            <a href="https://github.com/mapnik/mapnik/wiki/Image-IO">https://github.com/mapnik/mapnik/wiki/Image-IO</a>
+                                    </td>
                 <td>Mapnik image formats documentation</td>
             </tr>
             </table>