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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
# This file contains configuration options for harbored-mod (hmod).
#
# By default, hmod loads configuration from file 'hmod.cfg' in the directory from where
# hmod is running, if such file exists. These configuration options can also be passed
# as command-line options for hmod, overriding contents of the config file, if any,
# with the exception of options that allow multiple values (such as 'exclude' or
# 'macros') where the values specified as command-line options are *added* to the values
# in config file.
# Source code files or directories to document. Specify more than once to document more
# files/directories, e.g:
#
# source = ./source
# source = ./thirdparty
#
# This will document both the source code in the ./source/ and ./thirdparty/ directories.
#
# For DUB (http://code.dlang.org) projects, './source' is usually a good setting here.
source = ./source
# Name of the project. Used on the main page and possibly other places to help identify
# the project.
project-name = tinyendian
# Version of the project. Used on the main page and possibly other places to help
# identify the project.
project-version =
# Set to true to disable Markdown support, so that only DDoc is used.
no-markdown = false
# Directory where the generated documentation will be written.
output-directory = ./doc
# Output format. Supported values:
# html-simple
# Every function, variable, etc. will be documented in a separate
# HTML file. A documentation page of an aggregate (e.g. class) will
# link to these files. Generates a large number of files; not
# recommended for large projects.
# html-aggregated
# Members of an aggregate will be documented in the same file as the
# aggregate, unless they are aggregates themselves. That is, member
# functions or variables will be documented in the same file as the
# class that contains them, but a subclass will be documented in a
# separate file.
format = html-aggregated
# Modules or packages to exclude from generated documentation. Specify more than once to
# exclude more modules/packages, e.g:
#
# exclude = tharsis.util
# exclude = tharsis.entity.gamestate
#
# This will exclude both the package (or module) tharsis.util and module (or package)
# tharsis.entity.gamestate .
exclude =
# DDoc+markdown source of the main page of your documentation. Currently the main page is
# blank by default; this can be used to fill it with something useful.
index =
# Filename of DDoc+markdown source of additional content to add to the table of contents
# sidebar. Useful e.g. to add links to tutorials. Can be used more than once to add
# content from more files.
toc-additional =
# CSS file to use for styling. Can be used to replace the default style.
# To create a new style, you can start by generating the default style file with
# 'hmod --generate-css CSS_OUT_FILE' (CSS_OUT_FILE is name the generated file will have)
# and then modifying the CSS to get the desired style.
css =
# File to load DDoc macros from. Can be used to override builtin macros or add new ones.
# Can be specified more than once to use multiple macro files, e.g.:
#
# macros = macros.ddoc
# macros = moremacros.ddoc
macros =
# Maximum file size of D modules harbored-mod will process, in kiB. Any file
# bigger than specified size will be ignored. Useful in rare cases when modules
# are huge enough that the parser spends too much memory.
# By default, we ignore modules bigger than 16MiB.
max-file-size = 16384
# Additional config file to load, if needed. Configuration options in specified file will
# override or add to any options specified before this line, and will be overridden by
# any options after this line. Think of it as including the config file in this file.
config =
#---------------------------------------------------------------------------
# Configuration options **only** useful for harbored-mod testing
#---------------------------------------------------------------------------
# Uncommenting these will result in printing help information; only useful for testing.
#
# # Print help message.
#
# help = true
#
#
# # Generate default CSS file and write it to specified file.
# generate-css = hmod-style.css
#
#
# # Generate default config file and write it to 'hmod.cfg'.
#
# generate-cfg = true
|
