2017 © Pedro Peláez
 

library phpdoc-md

PHP documentation generator, with markdown output

image

dcramble/phpdoc-md

PHP documentation generator, with markdown output

  • Friday, October 31, 2014
  • by dcramble
  • Repository
  • 1 Watchers
  • 0 Stars
  • 173 Installations
  • PHP
  • 5 Dependents
  • 0 Suggesters
  • 43 Forks
  • 0 Open issues
  • 10 Versions
  • 1 % Grown

The README.md

PHPDocumentor MarkDown export

This script will generate markdown (.md) API documentation files from a PHPDocumentor XML output file., (*1)

It only documents classes and interfaces., (*2)

This project was originally developed by Evert Pot. See his repo for more details., (*3)

Take a look at some Example Markdown API Docs., (*4)

Installation

This project assumes you have composer installed., (*5)

$ composer require dcramble/phpdoc-md "~0.1"

Usage

First ensure that phpdocumentor 2 is installed somewhere, after, you must generate a file called structure.xml., (*6)

The easiest is to create a temporary directory, for example named docs/ as phpDocumentor2 creates a lot of 'cache' directories., (*7)

# phpdoc command
mkdir docs
cd docs
phpdoc  -d [project path] -t . --template="xml"
rm -r phpdoc-cache-*

# Next, run phpdocmd:
phpdocmd structure.xml [outputdir]

Options

--lt [template]
    This specifies the 'template' for links we're generating. By default
    this is "%c.md".

--namespaced-names
    This specifies the fully qualified classes, with namespaces, should
    be printed.

This should generate all the .md files., (*8)

The Versions

31/10 2014

dev-master

9999999-dev https://github.com/dcramble/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

The Development Requires

by Evert Pot
by Gautam Chaudhary
by David Cramblett

php phpdoc markdown

30/10 2014

v0.1.1

0.1.1.0 https://github.com/dcramble/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

The Development Requires

by Evert Pot
by Gautam Chaudhary
by David Cramblett

php phpdoc markdown

01/09 2014

0.1.0

0.1.0.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

The Development Requires

by Evert Pot

php phpdoc markdown

11/02 2013

0.0.7

0.0.7.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

07/11 2012

0.0.6

0.0.6.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

07/11 2012

0.0.5

0.0.5.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

06/11 2012

0.0.4

0.0.4.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

06/11 2012

0.0.3

0.0.3.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

06/11 2012

0.0.2

0.0.2.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown

02/11 2012

0.0.1

0.0.1.0 https://github.com/evert/phpdoc-md

PHP documentation generator, with markdown output

  Sources   Download

MIT

The Requires

 

by Evert Pot

php phpdoc markdown