命名规则
需要从可读性、方便识别、减少码字时间和能准确表达含义等方面来考虑
项目命名
视情况挑选以下三种方式的其中一种：
Link-Cooperation
StarUI
starui
文件夹（模块）命名
使用小写英文，拆分子文件夹来分层级
Examples：
Text1
2
3
4
| fs/afs
fs/efs
fs/exfat
...
|
源文件和头文件命名
采用小写英文+下划线分割，另外对于C++的源文件，我们统一采用.cc后缀
Examples：
1
2
3
4
5
6
7
8
| widget.h
widget.cc
radio_button.cc
radio_button.cc
service_message.cc
service_message.cc
|
namesapce命名
统一采用小写英文字母
Examples：
1
2
3
4
5
6
7
| namespace starui
{
namespace component
{
}
}
|
宏
头文件保护宏
使用__[模块路径_模块名]_H的命名规则，其中[]内的使用大写英文+下划线分割的方法
Examples：
1
2
3
4
5
6
| #ifndef __STARUI_WIDGET_BUTTON_H
#define __STARUI_WIDGET_BUTTON_H
#endif
|
宏定义
使用大写英文+下划线分割的方法
Examples：
1
| #define USER_NAME "phantom"
|
宏函数
视情况使用函数相同的命名规则或者大写英文+下划线分割的方法
Examples：
1
2
3
4
5
| #define RELEASE_OBJECT(obj) { \
obj->release(); \
}
#define shoot_it(me, other) me->shoot(other)
|
结构体
结构体名采用与类相同的驼峰法进行命名，然后结构体的数据使用小写英文+下划线的命名方法
Examples：
1
2
3
4
5
6
| struct HumanBeing
{
int age;
std::string first_name;
std::string second_name;
};
|
enum和enum class命名
枚举体名和其成员都采用与类相同的驼峰法
Examples：
1
2
3
4
5
6
7
8
| enum class DeviceType
{
AudioMic,
AudioSpeaker,
Monitor,
Keyboard,
GamePad,
};
|
所有类型的常量
不管是全局范围内的常量、函数/方法内的常量、或者类的常量，都统一采用大写英文+下划线分割的规则
Examples：
1
2
3
4
5
6
7
8
9
10
11
12
| static const int USER_ID = 0;
class Bar
{
public:
const int VERSION_MAJOR_NUMBER = 1;
};
void foo()
{
const int DIV_FACTOR = 3;
}
|
函数
采用小写英文+下划线分割
Examples：
1
2
3
4
5
6
7
8
9
| void create_service()
{
}
void create_empty_folder()
{
}
|
函数参数和局部变量
采用小写英文+下划线分割
Examples：
1
2
3
4
5
| bool create_user(const std::string& user_name)
{
auto user_server = UserServer::instance();
return user_server->create_user(user_name);
}
|
函数内静态变量
使用s_前缀，后续部分采用小写英文+下划线分割
Examples：
1
2
3
4
5
| int counter()
{
static int s_count = 0;
return ++s_count;
}
|
全局变量
使用g_前缀，后续部分采用小写英文+下划线分割
Examples：
1
2
3
4
5
6
| static int g_counter = 0;
void foo()
{
}
|
类命名
类名采用驼峰法
Examples：
类成员方法
采用与普通函数同样的命名规则，小写英文+下划线分割
Examples：
1
2
3
4
5
6
| class HumanBeging
{
void run_to()
{
}
};
|
类静态方法
采用与成员方法同样的命名规则
Examples：
1
2
3
4
5
6
| class HumanBeging
{
static void kill()
{
}
};
|
类成员数据
不管是public、private还是protected，都采用_为前缀，后续部分小写英文+下划线的命名规则
Examples：
1
2
3
4
5
6
7
| class HumanBeging
{
private:
int _age;
std::string _first_name;
std::string _second_name;
};
|
类成员数据的getter和setter
getter采用成员数据去掉前缀来命名，setter采用修改前缀为set_
Examples：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| class HumanBeging
{
public:
int age()
{
return _age;
}
void set_age(int age)
{
_age = age;
}
private:
int _age;
};
|
类静态数据
静态数据采用两个下划线__为前缀，后续部分小写英文+下划线的命名规则
Examples：
1
2
3
4
5
6
7
8
9
10
11
| class HumanBegin
{
private:
int _age;
std::string _first_name;
std::string _second_name;
static int __count;
};
int HumanBeging::__count = 0;
|
接口命名规范
驼峰法+Interface
Examples：
1
2
3
4
| class ControllerInterface
{
};
|
注释规范
我把注释分为两种，一种是代码说明注释，另一种是文档注释。前者提供代码说明（比如做层次切割），后者则是用于辅助doxygen生成接口文档的，注释的规范我们参考JavaDoc规范。
另外以下不给出完整的例子，详细的例子我们放到编码规范内
代码说明注释和文档注释的区分
代码说明注释：
上面两种形式的注释，doxygen是不会为其产出文档的
文档注释：
代码说明注释
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
|
关于代码层次切割
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
|
foo();
bar();
foo();
bar();
bar();
|
Examples：
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
| Window create_main_view()
{
Window main_view;
main_view.set_title("main view");
main_view.set_size(500, 500);
Menu menu;
menu.add_action("退出", on_quit);
menu.add_action("打开", on_open);
main_view.set_menu(menu);
Canvas canvas;
canvas.set_size(300, 300);
canvas.set_background(Black);
main_view.add_widget(canvas);
Panel panel;
panel.add_action("放大", on_zoom_in);
panel.add_action("缩小", on_zoom_out);
main_view.add_widget(panel);
canvas.bind(Widget.Paint, paint);
panel.bind(Widget.clicked, clicked);
if (Window.exist(main_view.title()) {
Window.destroy(main_view.title());
}
return main_view;
}
|
文档注释
我们需要的文档注释包括：
我们参考JavaDoc的注释规范，在适当的地方可以插入一些html标签，另外doxygen也支持markdown。
关于多国语言处理，可以使用doxygen的if、else命令，不过目前我们不需要考虑这个。
对于C++，主要的文档注释留在头文件上，源文件只需要适当的少量注释。
JavaDoc Tag可以参考：
javadoc-The Java API Documentation Generator
Doxygen Command：
Doxygen Manual: Special Commands
tag主要使用javadoc与doxygen预定义的，我们统一以@[tag_name]来开始一个tag，下面例子中所有以@开头的，都是一个tag，通过doxygen会把这些tag的内容输出到产出文档中。
Examples：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
#ifndef __STARUI_BUTTON_H
#define __STARUI_BUTTON_H
#endif
|
我们挑选的基本的Tag列表（还有一些Tag在别的地方进行说明）：
| @file | 文件头注释 | 文件头注释必须 | 文件头注释指定了该Tag才能生成对应的File注释 | @file button.h |
| @author | | 对于文件注释必须，其它非必须 | 标记作者以及邮箱，可使用多个author tag来标记多个作者 | @author your name (you@domain) |
| @brief | | | brief对应简述，详细的描述应该放在/**下面的第一行开始，或者放到details中 | @brief It’s a opensource library |
| @details | | | 详细描述，或放在/**下面的第一行开始 | @details 这是详细描述 |
| @date | | | 创建日期 | @date 2022-10-23 |
| @version | | 尽量别用 | 版本号，可以通过变量控制，不过我们基本不需要使用这个tag，因为比较难控制 | @version 0.1.0 |
| @since | | 最好在关键接口上都加上 | 自什么版本开始引入的 | @since 0.1 |
| @see | | | 引用 | @see starui.Image |
| @copyright | 文件头注释 | 文件头注释必须 | 我们的许可证不写在这里，这里只写版权 | @copyright Copyright (c) 2022 Link-Cooperation |
| @deprecated | | | 标记被弃用，最好放到最末尾 | @deprecated 该接口跟新接口冲突 |
| {@link} | | | 嵌入引用 | @brief it's StarUI Button {@link starui.Image} |
额外提示信息Tag列表
| @note | | | 注解 | @note 这是一个注解 |
| @remark | | | 备注 | @remark 这是一个备注 |
| @attention | | | 注意事项 | @attention 这是一个注意事项 |
| @warning | | | 警告 | @warning 这是一个警告 |
| @bug | | | 存在bug | @bug 这里存在一个XXX Bug |
锚点以及引用
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
class Button
{
public:
Button();
};
|
Todo列表
提供Example代码
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
void doing()
{
}
|
指示Example位置
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
class Button
{
};
void create_push_button()
{
Button button;
}
|
指示测试用例
指示可能抛出的异常
1
2
3
4
5
6
7
8
9
10
11
12
13
|
class Button
{
public:
void create();
}
|
分组
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
|
#define LESS(a, b) a < b
#define GREATER(a, b) a > b
#define ID 1
#define COUNT 10
|
名字空间
我们的规则是：
以下例子命名空间结构为：
1
2
3
4
5
| namespace starui
{
namespace widget {
}
}
|
widget.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
namespace starui
{
namespace widget
{
class BaseWidget
{
};
}
}
|
button.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
| #include <widget.h>
namespace starui
{
namespace widget
{
class Button : public BaseWidget
{
};
}
}
|
模块
模块相关的规则：
下面是几个例子
例子1：
widget.h
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
|
namespace starui
{
namespace widget
{
class BaseWidget
{
};
}
}
|
button.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| #include <widget.h>
namespace starui
{
namespace widget
{
class Button : public BaseWidget
{
};
}
}
|
例子2：
最好别用这种做法，会让代码看起来非常混乱
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
namespace render
{
class BaseRender
{
};
}
|
宏
看下面的例子，对于直接在宏前面加注释，是不需要@def Tag的，在其它地方补充注释的话，才需要@def。像结构体（@struct）、枚举(@enum)、函数(@fn)等都是类似的，所以这些的说明就都跳过了。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
#define LESS(a, b) a < b
#define GREATER(a, b) a > b
#define PI 3.14
#define ID 100
|
枚举体
1
2
3
4
5
6
7
8
9
10
11
|
enum class DeviceType
{
Audio,
Video
};
|
结构体
1
2
3
4
5
6
7
8
9
10
11
|
struct Device
{
int id;
char name[250];
};
|
函数
对于参数我们使用[in]、[out]和[in out]，来表示其输入或输出。
对于返回值，@return、@returns和@result三个是等效的，我们一般使用@return即可，如果需要对返回值分情况进行解释，可补充@retval
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
| enum class Status
{
Ok,
Failed
};
int create_system(int id, const std::string& user_name, void* instance, Status* status)
{
return 0;
}
int create_system_2(int id, const std::string& user_name, void* instance, int* status)
{
return 0;
}
Status create_system_3(int id, const std::string& user_name, void* instance, int* status)
{
return Status::Ok;
}
|
Doxygen相关参考
Doxygen手册：
Doxygen Manual: Overview
Doxygen命令：
Doxygen Manual: Special Commands
JavaDoc相关参考
JavaDoc：
How to Write Doc Comments for the Javadoc Tool
JavaDocTags：
javadoc-The Java API Documentation Generator
JavaDoc - The Java API Documentation Generator：
javadoc-The Java API Documentation Generator
编码规范
直接看例子，目录结构如下：
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
|
#ifndef __STARUI_BASE_WIDGET_H
#define __STARUI_BASE_WIDGET_H
namespace starui
{
namespace widget
{
class BaseWidget
{
public:
BaseWidget(BaseWidget* parent);
virtual ~BaseWidget();
BaseWidget* parent() const;
protected:
BaseWidget* _parent;
};
}
}
#endif
|
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
|
#include <widget/base_widget.h>
namespace starui
{
namespace widget
{
BaseWidget::BaseWidget(BaseWidget* parent)
: _parent(parent)
{
}
BaseWidget::~BaseWidget()
{
}
BaseWidget* BaseWidget::parent() const
{
return _parent;
}
}
}
|
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
|
#ifndef __STARUI_BUTTON_H
#define __STARUI_BUTTON_H
#include <widget/base_widget.h>
#include <string>
namespace starui
{
namespace widget
{
enum class ButtonType
{
PushButton,
CheckBox
};
enum class HitResult
{
Hitted,
NotHitted
};
typedef struct
{
int x;
int y;
} Point, *PPoint;
typedef struct
{
int x;
int y;
int width;
int height;
} Rect, *PRect;
class Button : public BaseWidget
{
public:
Button(const std::string& text, ButtonType type);
std::string text() const;
void set_text(const std::string& text);
ButtonType type() const;
void change_type(ButtonType type);
Rect area() const;
void update_area(const Rect& rect);
HitResult hit_test(const Point& pt) const;
int status() const;
protected:
std::string _text;
ButtonType _type;
Rect _area;
};
}
}
#endif
|
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
|
#include <widget/button.h>
namespace starui
{
namespace widget
{
Button::Button(const std::string& text, ButtonType type)
: _parent(nullptr),
_text(text),
_type(type)
{
}
std::string Button::text() const
{
return _text;
}
void Button::set_text(const std::string& text)
{
_text = text;
}
ButtonType Button::type() const
{
return _type;
}
void Button::change_type(ButtonType type)
{
_type = type;
}
Rect Button::area() const
{
return _area;
}
void Button::update_area(const Rect& rect)
{
_area = rect;
}
HitResult Button::hit_test(const Point& pt) const
{
return HitResult::Hitted;
}
int Button::status() const
{
return 0;
}
}
}
|
tests
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
|
#ifndef __STARUI_TEST_BUTTON_H
#define __STARUI_TEST_BUTTON_H
class TestButton
{
void test_create_button();
};
#endif
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
#include <tests/test_button.h>
#include <widget/button.h>
void TestButton::test_create_button()
{
starui::widget::Button button("hello", starui::widget::ButtonType::PushButton);
}
|
examples
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
#include <widget/button.h>
void example_create_push_button()
{
starui::widget::Button button("hello", starui::widget::ButtonType::PushButton);
}
|
Doxyfile
精简版（去掉默认未改动的参数）：
1
2
3
4
5
6
7
8
| PROJECT_NAME = StarUI
PROJECT_NUMBER = 0.1.0
PROJECT_BRIEF = "StarUI it's a tiny opensource ui library"
OUTPUT_DIRECTORY = starui_docs
INPUT = .
RECURSIVE = YES
EXAMPLE_PATH = examples
SOURCE_BROWSER = YES
|
完整版：
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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
| DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = StarUI
PROJECT_NUMBER = 0.1.0
PROJECT_BRIEF = "StarUI it's a tiny opensource ui library"
PROJECT_LOGO =
OUTPUT_DIRECTORY = starui_docs
CREATE_SUBDIRS = NO
CREATE_SUBDIRS_LEVEL = 8
ALLOW_UNICODE_NAMES = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class" \\
"The $name widget" \\
"The $name file" \\
is \\
provides \\
specifies \\
contains \\
represents \\
a \\
an \\
the
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
JAVADOC_BANNER = NO
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
PYTHON_DOCSTRING = YES
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO
OPTIMIZE_OUTPUT_SLICE = NO
EXTENSION_MAPPING =
MARKDOWN_SUPPORT = YES
TOC_INCLUDE_HEADINGS = 5
AUTOLINK_SUPPORT = YES
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
IDL_PROPERTY_SUPPORT = YES
DISTRIBUTE_GROUP_DOC = NO
GROUP_NESTED_COMPOUNDS = NO
SUBGROUPING = YES
INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS = NO
TYPEDEF_HIDES_STRUCT = NO
LOOKUP_CACHE_SIZE = 0
NUM_PROC_THREADS = 1
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_PRIV_VIRTUAL = NO
EXTRACT_PACKAGE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
RESOLVE_UNNAMED_PARAMS = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = SYSTEM
HIDE_SCOPE_NAMES = NO
HIDE_COMPOUND_REFERENCE= NO
SHOW_HEADERFILE = YES
SHOW_INCLUDE_FILES = YES
SHOW_GROUPED_MEMB_INC = NO
FORCE_LOCAL_INCLUDES = NO
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = NO
STRICT_PROTO_MATCHING = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = YES
FILE_VERSION_FILTER =
LAYOUT_FILE =
CITE_BIB_FILES =
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_IF_INCOMPLETE_DOC = YES
WARN_NO_PARAMDOC = NO
WARN_AS_ERROR = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LINE_FORMAT = "at line $line of file $file"
WARN_LOGFILE =
INPUT = .
INPUT_ENCODING = UTF-8
INPUT_FILE_ENCODING =
FILE_PATTERNS = *.c \\
*.cc \\
*.cxx \\
*.cpp \\
*.c++ \\
*.java \\
*.ii \\
*.ixx \\
*.ipp \\
*.i++ \\
*.inl \\
*.idl \\
*.ddl \\
*.odl \\
*.h \\
*.hh \\
*.hxx \\
*.hpp \\
*.h++ \\
*.l \\
*.cs \\
*.d \\
*.php \\
*.php4 \\
*.php5 \\
*.phtml \\
*.inc \\
*.m \\
*.markdown \\
*.md \\
*.mm \\
*.dox \\
*.py \\
*.pyw \\
*.f90 \\
*.f95 \\
*.f03 \\
*.f08 \\
*.f18 \\
*.f \\
*.for \\
*.vhd \\
*.vhdl \\
*.ucf \\
*.qsf \\
*.ice
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH = examples
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
FORTRAN_COMMENT_AFTER = 72
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
REFERENCES_LINK_SOURCE = YES
SOURCE_TOOLTIPS = YES
USE_HTAGS = NO
VERBATIM_HEADERS = YES
CLANG_ASSISTED_PARSING = NO
CLANG_ADD_INC_PATHS = YES
CLANG_OPTIONS =
CLANG_DATABASE_PATH =
ALPHABETICAL_INDEX = YES
IGNORE_PREFIX =
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET =
HTML_EXTRA_FILES =
HTML_COLORSTYLE = AUTO_LIGHT
HTML_COLORSTYLE_HUE = 220
HTML_COLORSTYLE_SAT = 100
HTML_COLORSTYLE_GAMMA = 80
HTML_TIMESTAMP = NO
HTML_DYNAMIC_MENUS = YES
HTML_DYNAMIC_SECTIONS = NO
HTML_INDEX_NUM_ENTRIES = 100
GENERATE_DOCSET = NO
DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_FEEDURL =
DOCSET_BUNDLE_ID = org.doxygen.Project
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME = Publisher
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
CHM_INDEX_ENCODING =
BINARY_TOC = NO
TOC_EXPAND = NO
GENERATE_QHP = NO
QCH_FILE =
QHP_NAMESPACE = org.doxygen.Project
QHP_VIRTUAL_FOLDER = doc
QHP_CUST_FILTER_NAME =
QHP_CUST_FILTER_ATTRS =
QHP_SECT_FILTER_ATTRS =
QHG_LOCATION =
GENERATE_ECLIPSEHELP = NO
ECLIPSE_DOC_ID = org.doxygen.Project
DISABLE_INDEX = NO
GENERATE_TREEVIEW = NO
FULL_SIDEBAR = NO
ENUM_VALUES_PER_LINE = 4
TREEVIEW_WIDTH = 250
EXT_LINKS_IN_WINDOW = NO
OBFUSCATE_EMAILS = YES
HTML_FORMULA_FORMAT = png
FORMULA_FONTSIZE = 10
FORMULA_MACROFILE =
USE_MATHJAX = NO
MATHJAX_VERSION = MathJax_2
MATHJAX_FORMAT = HTML-CSS
MATHJAX_RELPATH =
MATHJAX_EXTENSIONS =
MATHJAX_CODEFILE =
SEARCHENGINE = YES
SERVER_BASED_SEARCH = NO
EXTERNAL_SEARCH = NO
SEARCHENGINE_URL =
SEARCHDATA_FILE = searchdata.xml
EXTERNAL_SEARCH_ID =
EXTRA_SEARCH_MAPPINGS =
GENERATE_LATEX = YES
LATEX_OUTPUT = latex
LATEX_CMD_NAME =
MAKEINDEX_CMD_NAME = makeindex
LATEX_MAKEINDEX_CMD = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4
EXTRA_PACKAGES =
LATEX_HEADER =
LATEX_FOOTER =
LATEX_EXTRA_STYLESHEET =
LATEX_EXTRA_FILES =
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
LATEX_BIB_STYLE = plain
LATEX_TIMESTAMP = NO
LATEX_EMOJI_DIRECTORY =
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_SUBDIR =
MAN_LINKS = NO
GENERATE_XML = NO
XML_OUTPUT = xml
XML_PROGRAMLISTING = YES
XML_NS_MEMB_FILE_SCOPE = NO
GENERATE_DOCBOOK = NO
DOCBOOK_OUTPUT = docbook
GENERATE_AUTOGEN_DEF = NO
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES
DIA_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
DOT_NUM_THREADS = 0
DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
DOT_FONTPATH =
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
UML_LIMIT_NUM_FIELDS = 10
DOT_UML_DETAILS = NO
DOT_WRAP_THRESHOLD = 17
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DIR_GRAPH_MAX_DEPTH = 1
DOT_IMAGE_FORMAT = png
INTERACTIVE_SVG = NO
DOT_PATH =
DOTFILE_DIRS =
MSCFILE_DIRS =
DIAFILE_DIRS =
PLANTUML_JAR_PATH =
PLANTUML_CFG_FILE =
PLANTUML_INCLUDE_PATH =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 0
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
|
生成文档
