xeoncross/pocco

The PHP documentation generator (A Docco clone)

dev-master 2013-07-25 17:26 UTC

Requires

• php: >=5.2.0

MIT License

• Xeoncross

README

The PHP documentation generator that uses your existing source code! Based on the awesome Docco Javascript documentation generator (but with improvements for PHP!).

Example

First you need to install the library using Composer. Create a composer.json file in your documentation folder and type this:

{
	"require": {
		"xeoncross/pocco": "dev-master"
	}
}

After you have created a composer.json file you can install Pocco.

$ composer install

Next, create an index.php file and include and run Pocco.

<?php

// Include Directly
//require('pocco/src/Xeoncross/Pocco.php');

// or with Composer (recomended)
require('vendor/autoload.php');

$dir = realpath('/var/www/path/to/project/') . '/';
$default_file_to_show = null;
$requested_file_to_show = isset($_GET['file']) ? $_GET['file'] : null;

$pocco = new Xeoncross\Pocco;

if( ! $pocco->display($dir, $default_file_to_show, $requested_file_to_show)) {

	header('HTTP/1.0 404 Not Found');
	die("404 - File not Found");

}

Created by David Pennington