-
Notifications
You must be signed in to change notification settings - Fork 80
/
apigen.neon
55 lines (38 loc) · 1.44 KB
/
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# list of scanned file extensions (e.g. php5, phpt...)
extensions: [php]
# directories and files matching this file mask will not be parsed
exclude:
- examples/
# similar to above, but this files will be included in class tree
skipDocPath:
- *Component\Console
# character set of source files; if you use only one across your files, we recommend you name it
charset: [UTF-8]
# title of generated documentation
title: TMDB PHP API Documentation
# base url used for sitemap (useful for public doc)
baseUrl: http://api.apigen.org
# custom search engine id, will be used by search box
googleCseId: 011549293477758430224
# Google Analytics tracking code
googleAnalytics: UA-35236-5
# choose ApiGen template theme
templateTheme: bootstrap # or: default
# the way elements are grouped in menu
groups: auto # also: namespace, packages, none; auto will detect namespace first, than packages
# access levels of included method and properties
accessLevels: [public, protected, private] # also [private]
# include elements marked as @internal/{@internal}
internal: true
# generate documentation for PHP internal classes
php: true
# generate highlighted source code for elements
sourceCode: true
# generate tree view of classes, interfaces, traits and exceptions
tree: false
# generate documentation for deprecated elements
deprecated: true
# generate list of tasks with @todo annotation
todo: false
# add link to ZIP archive of documentation
download: false