Store Locator Plus® PHP Code Documentation

Generating The Documentation

The phpDocumentor tool is used to generate the docs via a Docker image. You will need Docker installed to generate the docs.

In the main plugins directory (~/phpStorm Projects/WordPress/wp-content/plugins) drop in the following phpdoc.dist.xml file. This version will generate documentation for the SLP and Power add on in a single HTML subsite.

<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
        configVersion="3"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="https://www.phpdoc.org"
>
    <title>Store Locator Plus®</title>
    <paths>
        <output>.phpdoc/slp</output>
        <cache>.phpdoc/cache</cache>
    </paths>
    <version number="latest">
        <!-- SLP base plugin -->
        <api>
            <source dsn="./store-locator-le">
                <path>include/**/*</path>
            </source>
            <default-package-name>Store Locator Plus</default-package-name>
            <include-source>true</include-source>
        </api>
        <!-- Power Add On -->
        <api>
            <source dsn="./slp-power">
                <path>include/**/*</path>
            </source>
            <default-package-name>Power</default-package-name>
            <include-source>true</include-source>
        </api>
    </version>
</phpdocumentor>

Running The Documentor

Open a command line terminal at the root directory (~/phpStorm Projects/WordPress/wp-content/plugins) and run the docker image:

docker run --rm -v "$(pwd):/data" "phpdoc/phpdoc:3"

This will create a new .phpdoc folder with the cache and docsite folder.

The local folder structure for php docs.

You can open the index.html locally to view the code.

Deploying The Documentation

Connect with SFTP to this website and push the ./phpdoc/docsite folder up to /home/bitnami/stack/wordpress/phpdoc/ folder.

Commenting The Code

The code modules are documented with phpDoc style comments. These are used to generate HTML documents that are uploaded to this server.

Known Bugs