PHPackages                             firesphere/silverstripe-docgenerator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. firesphere/silverstripe-docgenerator

ActiveSilverstripe-module

firesphere/silverstripe-docgenerator
====================================

Generate APIGen docs on flush

0.0.2(10y ago)4422BSD-3-ClausePHP

Since Apr 16Pushed 6y ago1 watchersCompare

[ Source](https://github.com/Firesphere/silverstripe-docgenerator)[ Packagist](https://packagist.org/packages/firesphere/silverstripe-docgenerator)[ RSS](/packages/firesphere-silverstripe-docgenerator/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (4)Used By (0)

Docblock Generator
==================

[](#docblock-generator)

[![Scrutinizer](https://camo.githubusercontent.com/0e5834aa6824bcffd2f15c6b33d290c34f294ac00a807d79706f5fe65380650e/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f617879722f73696c7665727374726970652d696465616e6e6f7461746f722e737667)](https://scrutinizer-ci.com/g/CasaLaguna/silverstripe-docgenerator/badges/quality-score.png?b=master)[![CodeClimate](https://camo.githubusercontent.com/e95f797e862db9cd65fd68b54ae53bae480dc124dfc59811d3f5ffbbb6a9b399/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f466972657370686572652f73696c7665727374726970652d646f6367656e657261746f722f6261646765732f6770612e737667)](https://camo.githubusercontent.com/e95f797e862db9cd65fd68b54ae53bae480dc124dfc59811d3f5ffbbb6a9b399/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f466972657370686572652f73696c7665727374726970652d646f6367656e657261746f722f6261646765732f6770612e737667)[![Travis](https://camo.githubusercontent.com/7baba642d95d21ab401e32c0941719d3b44585cc586e0c2d3f8341ad65adc830/68747470733a2f2f7472617669732d63692e6f72672f466972657370686572652f73696c7665727374726970652d646f6367656e657261746f722e737667)](https://camo.githubusercontent.com/7baba642d95d21ab401e32c0941719d3b44585cc586e0c2d3f8341ad65adc830/68747470733a2f2f7472617669732d63692e6f72672f466972657370686572652f73696c7665727374726970652d646f6367656e657261746f722e737667)

This tiny wrapper on APIGen will generate documentation from your PHP Docblocks annotations. There's really nothing more to it.

Usage
=====

[](#usage)

Add the wished module, and it's target directory in your config.yml like this:

```
DocGenerator:
  enabled: false
  document_modules:
    modulename: "Target/Directory/Relative/to/DocRoot"
```

Adviced is to only enable it in dev, like this:

```
Only:
  environment: 'dev'
---
DocGenerator:
  enabled: true
  document_modules:
    docgenerator: "docgenerator/docs/en/apidocs"
```

Documentation build by APIGen will be build in the target directory specific for each module.

Also, you can generate single API docs for multiple directories/modules at once:

```
---
Only:
  environment: 'dev'
---
DocGenerator:
  enabled: true # doc generator control switch
  multi_module_enabled: true # multi module doc generator control switch
  multi_module_destination: "apidocs" # documentation generator target directory
  multi_modules:
    - mysite
    - framework
    - mymodule
    - myothermodule
    - ...
```

Documentation build by APIGen `multi_module_enabled: true` will be stored in single directory.

Did you read this entire readme? You rock!
------------------------------------------

[](#did-you-read-this-entire-readme-you-rock)

Pictured below is a cow, just for you.

```

               /( ,,,,, )\
              _\,;;;;;;;,/_
           .-"; ;;;;;;;;; ;"-.
           '.__/`_ / \ _`\__.'
              | (')| |(') |
              | .--' '--. |
              |/ o     o \|
              |           |
             / \ _..=.._ / \
            /:. '._____.'   \
           ;::'    / \      .;
           |     _|_ _|_   ::|
         .-|     '==o=='    '|-.
        /  |  . /       \    |  \
        |  | ::|         |   | .|
        |  (  ')         (.  )::|
        |: |   |;  U U  ;|:: | `|
        |' |   | \ U U / |'  |  |
        ##V|   |_/`"""`\_|   |V##
           ##V##         ##V##

```

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 90.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

3

Last Release

3674d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8497c885d84e4bf94b8e6136292aa602124a50bbbb4a14ab00e1423f232e7663?d=identicon)[Firesphere](/maintainers/Firesphere)

---

Top Contributors

[![Firesphere](https://avatars.githubusercontent.com/u/680570?v=4)](https://github.com/Firesphere "Firesphere (20 commits)")[![jelicanin](https://avatars.githubusercontent.com/u/692844?v=4)](https://github.com/jelicanin "jelicanin (2 commits)")

---

Tags

hacktoberfestdocumentationannotationsdocblocksilverstripe

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/firesphere-silverstripe-docgenerator/health.svg)

```
[![Health](https://phpackages.com/badges/firesphere-silverstripe-docgenerator/health.svg)](https://phpackages.com/packages/firesphere-silverstripe-docgenerator)
```

###  Alternatives

[doctrine/lexer

PHP Doctrine Lexer parser library that can be used in Top-Down, Recursive Descent Parsers.

11.2k910.8M117](/packages/doctrine-lexer)[silverstripe/cms

The SilverStripe Content Management System

5163.4M1.3k](/packages/silverstripe-cms)[silverleague/ideannotator

Generate PHP DocBlock annotations for DataObject and DataExtension databasefields and relation methods

4768.0k43](/packages/silverleague-ideannotator)[minime/annotations

The KISS PHP annotations library

229378.6k36](/packages/minime-annotations)[jan-swiecki/simple-annotations

Simple annotation parser

66615.0k18](/packages/jan-swiecki-simple-annotations)[silverstripe/admin

SilverStripe admin interface

262.6M325](/packages/silverstripe-admin)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)