PHP Classes

PHP Readme Helper: API documentation generator for README files

Recommend this page to a friend!
     
  Info   View files Example   View files View files (25)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not yet rated by the usersTotal: 81 All time: 10,002 This week: 148Up
Version License PHP version Categories
php-readme-helper 1.0.0MIT/X Consortium ...7Utilities and Tools, Project Management, L..., P..., P...
Description 

Author

Lars Moelleken

This package can be used as an API documentation generator for README files.

It can scan a given directory to find class files or check a given class file to extract documentation about the class functions and variables.

The package can generate a new README file from a template file in Markdown format and returns it as a string.

Optionally it can restrict the generated documentation to a given list of class functions.

Innovation Award
PHP Programming Innovation award nominee
May 2020
Number 8		 Many API developers produce documentation for their APIs in README files using the Markdown format.

This package can generate automatic documentation README files for APIs by extracting such documentations from API source files.

Manuel Lemos
Picture of Lars Moelleken
  Performance   Level  
Name: Lars Moelleken <contact>
Classes: 25 packages by
Country: Germany Germany
Age: 35
All time rank: 62940 in Germany Germany
Week rank: 81 Up4 in Germany Germany Up

Level 5 StarStarStarStarStar

 Innovation award
Innovation award
Nominee: 11x

Winner: 1x

Example

<?php

require __DIR__ . '/../vendor/autoload.php';

$readmeGenerator = new \voku\PhpReadmeHelper\GenerateApi();

$readmeGenerator->hideTheFunctionIndex = true;

$readmeGenerator->templateMethod = <<<RAW
#### %name%
<a href="#voku-php-readme-class-methods">?</a>
%description%

**Parameters:**
%params%

**Return:**
%return%

--------
RAW;

$readmeText = ($readmeGenerator)->generate(
    __DIR__ . '/../src/voku/PhpReadmeHelper/GenerateApi.php',
    __DIR__ . '/docs/base.md'
);

file_put_contents(__DIR__ . '/../README.md', $readmeText);

  Files folder image Files  
File Role Description
Files folder image.github (3 files)
Files folder imagebuild (1 file, 1 directory)
Files folder imagesrc (1 directory)
Files folder imagetests (3 files, 1 directory)
Accessible without login Plain text file .editorconfig Data Auxiliary data
Accessible without login Plain text file .scrutinizer.yml Data Auxiliary data
Accessible without login Plain text file .styleci.yml Data Auxiliary data
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file CHANGELOG.md Data Auxiliary data
Accessible without login Plain text file circle.yml Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file LICENSE.txt Doc. Documentation
Accessible without login Plain text file phpcs.php_cs Example Example script
Accessible without login Plain text file phpstan.neon Data Auxiliary data
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file psalm.xml Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  .github  
File Role Description
  Accessible without login Plain text file CONTRIBUTING.md Data Auxiliary data
  Accessible without login Plain text file ISSUE_TEMPLATE.md Data Auxiliary data
  Accessible without login Plain text file PULL_REQUEST_TEMPLATE.md Data Auxiliary data

  Files folder image Files  /  build  
File Role Description
Files folder imagedocs (1 file)
  Accessible without login Plain text file generate_docs.php Example Example script

  Files folder image Files  /  build  /  docs  
File Role Description
  Accessible without login Plain text file base.md Data Auxiliary data

  Files folder image Files  /  src  
File Role Description
Files folder imagevoku (1 directory)

  Files folder image Files  /  src  /  voku  
File Role Description
Files folder imagePhpReadmeHelper (2 files, 1 directory)

  Files folder image Files  /  src  /  voku  /  PhpReadmeHelper  
File Role Description
Files folder imageTemplate (1 file)
  Plain text file GenerateApi.php Class Class source
  Plain text file GenerateStringHelper.php Class Class source

  Files folder image Files  /  src  /  voku  /  PhpReadmeHelper  /  Template  
File Role Description
  Plain text file TemplateFormatter.php Class Class source

  Files folder image Files  /  tests  
File Role Description
Files folder imagefixtures (1 file)
  Accessible without login Plain text file bootstrap.php Aux. Auxiliary script
  Plain text file Dummy.php Class Class source
  Plain text file PhpDocHelperTest.php Class Class source

  Files folder image Files  /  tests  /  fixtures  
File Role Description
  Accessible without login Plain text file base.md Data Auxiliary data

Downloadphp-readme-helper-2020-05-15.zip 18KB
Downloadphp-readme-helper-2020-05-15.tar.gz 14KB
Install with ComposerInstall with Composer
Needed packages  
Class DownloadWhy it is needed Dependency
Simple PHP Code Parser Download .zip .tar.gz the code parser is needed to get the informations from the php files Required
 Version Control Unique User Downloads Download Rankings  
 100%
Total:81
This week:0
All time:10,002
This week:148Up

  Applications that use this package  
No pages of applications that use this class were specified.

Add link image If you know an application of this package, send a message to the author to add a link here.