Welcome to jphpdoc project

jphpdoc is a generator of documents from php source code. It will be used to document Jelix source code.

The goal of jphpdoc is to provide a tool easily and highly configurable, fast and designed only for PHP5 source code.

Main Features planned :

  • Runs from command line
  • Parses tags which are similar to javadoc tags or phpdocumentor tags
  • It could parse your own tags by providing corresponding tag parsers
  • jPhpdoc is based on a main parser and on some generators. Both parser and generators are independant so you can provide your own generators (which use data objects provided by the parser).
  • There will be by default :
    • an HTML generator, which will use some jTpl templates to generate static html files.
    • a DB generator : it will store datas in a database instead of files. A Jelix module will be also provided to display contents from this database, and it will content a search engine.

More features will be added as needed..

Repository access

You can access to the subversion repository at this url : http://forge.jelix.org/svn/jphpdoc

Wiki

Download in other formats: Plain Text