samsara/roster

A PHP console tool to generate Markdown documentation from your docblocks and types hints using templates.

Fund package maintenance!
JordanRL

v0.1.5 2021-07-08 11:13 UTC

This package is auto-updated.

Last update: 2022-09-08 23:48:15 UTC


README

Installation

To install, simply require the package using composer:

composer --dev require "samsara/roster:^0.1"

Or include it in your composer.json file:

{
    "require-dev": {
        "samsara/roster": "^0.1"
    }
}

The project namespace is Samsara\Roster\*. You can view the project on Packagist.

Examples of Documentation Built With Roster

  • Roster: This console program! Of course Roster builds its own documentation. :)
  • Fermat: An arbitrary precision math library with trigonometry, statistics and more for PHP.

Documentation

After installing, from your project root on the command-line use:

php vendor/bin/roster [SOURCES_ROOT]

You can read the full documentation for Roster here.