Skip to content

Instantly share code, notes, and snippets.

@jlamim
Created January 31, 2017 13:26
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jlamim/4d55781192c427a014edd6e8e83b92b9 to your computer and use it in GitHub Desktop.
Save jlamim/4d55781192c427a014edd6e8e83b92b9 to your computer and use it in GitHub Desktop.
Apigen - Arquivo de configuração
# Título que será exibido na documentação
title: 'Exemplo de documentação com CodeIgniter e APIGEN'
# Template utilizado na documentação: default, bootstrap
templateTheme: 'default'
# Diretório onde está o código-fonte que deve ter a documentação gerada
source:
- 'application'
# Diretórios que devem ser ignorados durante o processo de geração da documentação
exclude:
- 'cache'
- 'language'
- 'logs'
- 'third_party'
- 'views'
# Diretório onde a documentação deverá ser criada
destination: 'doc'
# Níveis de acesso a variáveis e funções que devem ser documentados
accessLevels:
- 'public'
- 'private'
- 'protected'
# Se marcado como FALSE, as marcações @deprecated não serão adicionadas à documentação
deprecated: false
# Se marcado como TRUE, as marcações @todo serão adicionadas à documentação
todo: true
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment