This repository has been archived by the owner on May 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apigen.neon
52 lines (50 loc) · 1.59 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
# Source file or directory to parse
source: src
# Directory where to save the generated documentation
destination: docs
# List of allowed file extensions
extensions: [php]
# Mask to exclude file or directory from processing
exclude:
# Don't generate documentation for classes from file or directory with this mask
skipDocPath:
# Don't generate documentation for classes with this name prefix
skipDocPrefix:
# Character set of source files
charset: auto
# Main project name prefix
main: Jasny\
# Title of generated documentation
title: 'Jasny DB REST · API documentation'
# Documentation base URL
baseUrl: http://jasny.github.com/db-rest/docs
# Google Custom Search ID
googleCseId:
# Google Custom Search label
googleCseLabel:
# Google Analytics tracking code
googleAnalytics:
# Grouping of classes
groups: auto
# List of allowed HTML tags in documentation
allowedHtml: [code]
# Element types for search input autocomplete
autocomplete: [classes, constants, functions]
# Generate documentation for methods and properties with given access level
accessLevels: [public]
# Generate documentation for elements marked as internal and display internal documentation parts
internal: No
# Generate documentation for PHP internal classes
php: No
# Generate tree view of classes, interfaces and exceptions
tree: Yes
# Generate documentation for deprecated classes, methods, properties and constants
deprecated: No
# Generate documentation of tasks
todo: No
# Generate highlighted source code files
sourceCode: Yes
# Add a link to download documentation as a ZIP archive
download: No
# Wipe out the destination directory first
wipeout: Yes