firesphere/silverstripe-docgenerator

Generate APIGen docs on flush

Docblock Generator

, _(*1)

This tiny wrapper on APIGen will generate documentation from your PHP Docblocks annotations. There's really nothing more to it., _(*2)

Usage

Add the wished module, and it's target directory in your config.yml like this:, _(*3)

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

Adviced is to only enable it in dev, like this:, _(*4)

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., _(*5)

Also, you can generate single API docs for multiple directories/modules at once:, _(*6)

---
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., _(*7)

Did you read this entire readme? You rock!

Pictured below is a cow, just for you., _(*8)

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