-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathapigen.neon
34 lines (26 loc) · 882 Bytes
/
apigen.neon
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# Título que será exibido na documentação
title: 'Sistema financeiro.'
# Template utilizado na documentação: default, bootstrap
templateTheme: 'bootstrap'
# Diretório onde está o código-fonte que deve ter a documentação gerada
source:
- 'app'
- 'assets'
- 'config'
# Diretórios que devem ser ignorados durante o processo de geração da documentação
exclude:
- 'banco'
- 'bower_components'
- 'node_modules'
- 'vendor'
# Diretório onde a documentação deverá ser criada
destination: 'docs'
# 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: false