/phpdoctor-html_bs

PHPDoctor Doclet for HTML output based on Bootstrap CSS

Primary LanguagePHP

PHPDoctor-HTML_BS

«HTML_BS» is a PHPDoctor Doclet to generate documentation in Bootstrap styled HTML format.

This Doclet developed on this forked version of original PHPDoctor generator and not tested with original package.

«HTML_BS» is based on «standard» doclet of PHPDoctor.

PHPDoctor itself is a little bit outdated (not support traits for example) but a pretty much useful in doc generation for code with a lot of Procedural programming and a number of @packages.

Install and setup

  • Download PHPDoctor bundle (if not done yet) than download «html_bs» package and unpack files in doclets/html_bs subfolder of PHPDoctor.

  • Make or change default INI file to set «HTML_BS» doclet and text formatter as follows:

    # To use «HTML_BS» as default
doclet = html_bs

# Recommended to set up formatter as text for better results
formatter = textFormatter

  • Configure other options as PHPDoctor documentation says.

Sample pages

This doclet developed for Cotonti CMS project as replacement for ugly standard HTML doclet.

For a demonstration of generation result for «HTML_BS» doclet you can view Cotonti API reference pages.

image

Changelog and versions

Last actual version is 0.5.0 and working in progress. So you can try last development version.

Author and license

Written by Andrew Matsovkin aka Macik and distributed under GNU license.

References