picongpu/docs/Doxyfile at dev · psychocoderHPC/picongpu · GitHub

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
PROJECT_NAME      = "PIConGPU"
XML_OUTPUT        = xml
INPUT             = ../include
INPUT             += ../README.md
GENERATE_LATEX    = NO
GENERATE_MAN      = NO
GENERATE_RTF      = NO
CASE_SENSE_NAMES  = NO
GENERATE_HTML     = NO
GENERATE_XML      = YES
XML_PROGRAMLISTING = NO
RECURSIVE         = YES
#QUIET             = YES
JAVADOC_AUTOBRIEF = YES
USE_MDFILE_AS_MAINPAGE = README.md

# ideally, you want to warn on missing doc coverage!
WARN_IF_UNDOCUMENTED = NO
WARN_NO_PARAMDOC = NO
# the ideal CI enforcing world: WARN_AS_ERROR = YES

# our CPP file names
FILE_PATTERNS          = *.cu       \
                         *.cpp      \
                         *.kernel   \
                         *.h        \
                         *.hpp      \
                         *.tpp      \
                         *.def      \
                         *.param    \
                         *.unitless \
                         *.loader   \
                         *.md

EXTENSION_MAPPING      = .cu=C++       \
                         .cpp=C++      \
                         .kernel=C++   \
                         .h=C++        \
                         .hpp=C++      \
                         .tpp=C++      \
                         .def=C++      \
                         .param=C++    \
                         .unitless=C++ \
                         .loader=C++