ilmiont/elucidate

This package is abandoned and no longer maintained. No replacement package was suggested.

Elucidate is a minimal library for generating PHP documentation from docblocks.

0.2.2 2019-02-15 12:34 UTC

Requires

• php: ^7.2

Requires (Dev)

• ilmiont/trainline: ^0.2.0

MIT

• James Walker

• documentation
• php
• docblocks

README

Elucidate is a minimal library for generating PHP documentation from docblocks.

It can iterate through all the classes in a given source folder, extract their docblocks, and make the information available to templates for documentation rendering.

The output is then placed into a destination directory with the same structure as the source directory.

Getting started

Install Elucidate to your project:

composer require ilmiont/elucidate --dev

You can now run Elucidate using the elucidate command in your shell.

Alternatively, run php vendor/ilmiont/elucidate/index.php directly.

Further documentation

Please refer to the Elucidate project wiki.

©James Walker 2019. Licensed under the MIT License.