firesphere/silverstripe-docgenerator

在刷新时生成APIGen文档

维护者

详细信息

github.com/Firesphere/silverstripe-docgenerator

源代码

问题

安装: 42

依赖: 0

建议: 0

安全: 0

星标: 4

关注者: 2

分支: 2

开放问题: 0

类型:silverstripe-module

0.0.2 2016-04-17 05:07 UTC

Requires

Requires (Dev)

BSD-3-Clause a8be431be34a8bf9d8320f9f19a17f6e51bd0e91

  • Simon 'Firesphere' Erkelens <simonerkelens.woop@silverstripe.com>

annotationsdocumentationsilverstripedocblock

This package is auto-updated.

Last update: 2024-08-29 03:58:08 UTC

README

Scrutinizer CodeClimate Travis

这是一个APIGen的微小包装器，可以从PHP Docblocks注释生成文档。实际上并没有更多的事情要做。

用法

将希望添加的模块及其目标目录添加到您的config.yml中，如下所示

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

建议只在开发环境中启用，如下所示

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

APIGen生成的文档将在针对每个模块的特定目标目录中构建。

此外，您还可以一次为多个目录/模块生成单个API文档

---
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
    - ...

由APIGen multi_module_enabled: true 生成的文档将存储在单个目录中。

您已经阅读了整个README吗？太棒了！

下面有一张图片，只为您。


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