John Davidson

Message:

When I generate API docs with phpDocumentor, the page Reports -> Markers always says No markers have been found in this project, despite I have several TODO markers in my PHP code.

I have phpDocumentor v3.0.0. I run it with: php phpDocumentor.phar --markers

My phpdoc.dist.xml file contains:

<?xml version="1.0" encoding="UTF-8" ?>

<phpdocumentor

  configVersion="3"

  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

  xmlns="https://www.phpdoc.org"

  xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"> 

  <paths>

    <output>apidocs/docs</output>

    <cache>apidocs/cache</cache>

  </paths>

  <version number="3.0.0">

    <api>

      <source dsn=".">

        <path>src</path>

        <path>*.php</path>

      </source>

      <markers>

        <marker>TODO</marker>

      </markers>

    </api>

  </version>

</phpdocumentor>

And I use TODO markers in my PHP code like this:

/**

 * TODO marker 1

 */

function someFunction(...) {

  // ...

}





function anotherFunction(...) {

  // TODO marker 2

  // ...

}

---

My Answer:
phpDocumentor is a tool used for generating documentation for PHP code. It parses PHP code and extracts information about classes, methods, properties, and other elements of the code to generate HTML or other formats of documentation. This documentation can be useful for developers to understand the structure and functionality of a codebase, and can also be used for API documentation.