aboutsummaryrefslogtreecommitdiffstats
path: root/doxygen/!readme.asciidoc
blob: 8fbca51ceb38f9b54738b1198da4d41f8d059aa2 (plain) (blame)
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299


doxygen 相關設定

===== Makefile

編譯doxygen document的Makefile, 裡面只有一個target: 'document',
另外有兩個環境變數:

- DOXYGEN_RUN_PATH: 指定doxygen執行的pwd, 預設為 `pwd`
- DOXYGEN_CONFIG: 指定config檔放在哪裡, 預設為 `pwd`

===== config

設置, 以下幾點個人覺得比較重要的

[source,conf]
-------------------------

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING      = UTF-8
PROJECT_NAME           = "Templates -- Meow"
PROJECT_NUMBER         = 1.1.2
PROJECT_BRIEF          = 不能, 也不應該先編譯成obj-file的templates
PROJECT_LOGO           = $(config_path)/logo.png
OUTPUT_DIRECTORY       = doc
CREATE_SUBDIRS         = NO
OUTPUT_LANGUAGE        = English
TAB_SIZE               = 2

#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = NO
EXTRACT_LOCAL_CLASSES  = YES
FORCE_LOCAL_INCLUDES   = YES

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT                  = meowpp
INPUT_ENCODING         = UTF-8
FILE_PATTERNS          =
RECURSIVE              = YES

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
HTML_HEADER            = $(config_path)/header.html
HTML_FOOTER            = $(config_path)/footer.html
HTML_STYLESHEET        = $(config_path)/stylesheet.css
HTML_EXTRA_STYLESHEET  = $(config_path)/custom.css
HTML_EXTRA_FILES       =
HTML_COLORSTYLE_HUE    = 120
HTML_COLORSTYLE_SAT    = 36
HTML_COLORSTYLE_GAMMA  = 166
DISABLE_INDEX          = YES
GENERATE_TREEVIEW      = YES
FORMULA_FONTSIZE       = 11
SEARCHENGINE           = NO

#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX         = YES
LATEX_CMD_NAME         = xelatex
PAPER_TYPE             = letter
HIDE_UNDOC_RELATIONS   = NO
UML_LOOK               = YES
EXTRA_PACKAGES         =
LATEX_HEADER           = $(config_path)/header.tex
LATEX_FOOTER           = $(config_path)/footer.tex

#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CALL_GRAPH             = YES
CALLER_GRAPH           = YES
-------------------------

[NOTE]
'config' 中 `$(config_path)` 是一個環境變數, 代表這個configure file所在位置
*呼叫asciidoc時必須有設置這個環境變數*


===== header.html

*HTML* output 的開頭
沒有更動

===== footer.html

*HTML* output 的結尾
沒有更動

===== logo.png

就是logo


===== stylesheet.css

*HTML* output 的css樣式, 我把他改成暗色系了

以下是更動的地方:
[source,css]
----------------------------------------------
body, table, div, p, dl {
    font: 400 14px/19px Roboto,sans-serif,monospace;
}

.title {
    line-height: 100%;
    font-size: 200%;
    margin :  0px;
    padding: 0px;
    border : 0px;
}

dt {
    color: #999999;
    font-style:italic;
}

div.qindex, div.navtab{
    background-color: #2B3F26;
}

a {
    color: #5D77AC;
}

.contents a:visited {
    color: #7695D2;
}

a.code, a.code:visited {
    color: #7695D2; 
}

a.codeRef, a.codeRef:visited {
    color: #7695D2; 
}

pre.fragment {
    background-color: #0B0C0D;
    border-radius: 4px;
    -moz-border-radius: 4px;
    -webkit-border-top-left-radius: 4px;
}

div.fragment {
    background-color: #0B0C0D;
    border-radius: 4px;
    -moz-border-radius: 4px;
    -webkit-border-top-left-radius: 4px;
}

div.line {
    font-family: 'courier new', monospace, fixed;
    color: #CCCCCC;
    font-size: 14px;
    min-height: 14px;
}

span.lineno {
    background-color: #181818;
}
span.lineno a {
    background-color: #3B3838;
}

span.lineno a:hover {
    background-color: #6B6868;
}

body {
    background-color: #212131;
    color: #DDFFDD;
}

span.keyword {
    color: #00A000
}

span.keywordtype {
    color: #907050
}

span.comment {
    color: #808080
}

div.center img {
    padding: 7px;
    background-color: #5F5572;
    border-radius: 4px;
    -moz-border-radius: 4px;
    -webkit-border-top-left-radius: 4px;
}

table.memberdecls {
    border-top-color: #111111;
}

.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
    background-color: #192322;
}

.mdescLeft, .mdescRight {
    color: #CCCCCC;
}

.memTemplParams {
    color: #7695D2;
}

.memtemplate {
    color: #7695D2;
}

.memproto, dl.reflist dt {
    color: #758575;
    text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.95);
    /* background-image:url('nav_f.png'); */
    background-color: #181C28;
}

.memdoc, dl.reflist dd {
    /* background-image:url('nav_g.png'); */
    background-color: #212A31;
}

.params .paramdir {
    color:#A0AA00;
}

.directory tr.even {
    background-color: #272838;
}

.directory .levels span {
    color: #5D77AC;
}

div.header
{
    /* background-image:url('nav_h.png'); */
    /* background-repeat:repeat-x; */
    background-color: #290A1C;
    padding: 0px;
    margin : 0px;
    border : 0px;
    margin-top: 10px;
    border-bottom: 1px solid #AA0000;/*#C4CFE5;*/
}

div.headertitle
{
    padding: 5px;
    margin : 0px;
    border : 0px;
}
 
#projectname
{
    font: 400% Tahoma, Arial,sans-serif,monospace;
}

div.toc h3 {
    color: #7695D2;
}

----------------------------------------------

===== custom.css

*HTML* output 的css樣式, 在這邊設定的話連 'navtree' 等都可以設定. +
另外這個檔案的檔名不能是 `navtree.css` , 不知道是不是bug.

===== header.tex

*LaTex* output 的開頭

===== header.tex

*LaTex* output 的結尾

===== stylesheet.sty

*LaTex* 的樣式設定