ellingham-technologies/phpxdoc

A PHP Documenter, lightweight and flexible


Keywords
incomplete, php, php-documentation, phpdocumentor
License
BSD-3-Clause

Documentation

PHPXDoc

Build Status codecov Latest Stable Version Latest Unstable Version Tested PHP Versions

Lightweight Documentor for PHP. Uses the built-in PHP reflection library and confirms (mostly) to the PHPDoc tags.

PHP Version Support

We officially support Version 7.1 and above. Support for PHP version 5 is not possible without significant changes.

Purpose for existing

PHPXDoc was created as an alternative to PHPDocumentor, solving a couple of problems along the way:

  • Reduced code complexity
  • Reduced dependencies
  • More versatile outputs (XML, HTML, Markdown, internally PHP objects in an array for third-party manipulation)
  • Support for PHP 7

Limitations

  • The initial spec does not include graphing
  • The initial spec does not include output to XSL
  • The initial spec does not include templating

Stage

  • Proposal (idea has merit, so create a specification)
  • Specification Note 1
  • Schedule (project plan and time estimates) Agreed Note 2
  • Project Acception (the project will go ahead)
  • Start work
    • Regular minor releases at key points
  • First major release (beta or RC release)
  • First release report (has the project specification been met? was the schedule accurate?)

Notes

  1. Specification doesn't meet normal criteria for detail
  2. This project has been marked as non-critical, development will follow a loose pace when time permits