core/Doxyfile at dev · WeatherStack/core · 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
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
# For an example, look here: https://github.com/libsdl-org/SDL/blob/main/docs/doxyfile

DOXYFILE_ENCODING       = UTF-8

PROJECT_NAME            = WeatherStack Core
PROJECT_NUMBER          = 1.0.0

CREATE_SUBDIRS          = YES

OUTPUT_LANGUAGE         = English

EXTRACT_ALL             = YES
EXTRACT_PRIVATE         = YES
EXTRACT_STATIC          = YES
EXTRACT_LOCAL_CLASSES   = YES
EXTRACT_LOCAL_METHODS   = YES
EXTRACT_ANON_NSPACES    = YES

SHOW_INCLUDE_FILES      = YES

GENERATE_TODOLIST       = YES
GENERATE_TESTLIST       = YES
GENERATE_BUGLIST        = YES
GENERATE_DEPRECATEDLIST = YES

# SHOW_DIRECTORIES is obsolete apparently
#SHOW_DIRECTORIES        = YES
SHOW_FILES              = YES
SHOW_NAMESPACES         = YES

WARN_IF_UNDOCUMENTED    = YES
WARN_IF_DOC_ERROR       = YES
WARN_NO_PARAMDOC        = YES
WARN_FORMAT             = "$file:$line: $text"
#WARN_LOGFILE            = ./doxygen_warn.txt
WARN_AS_ERROR           = FAIL_ON_WARNINGS_PRINT

# File patterns (https://github.com/libsdl-org/SDL/blob/main/docs/doxyfile#L589)
FILE_PATTERNS          = *.c \
                         *.cc \
                         *.cxx \
                         *.cpp \
                         *.c++ \
                         *.d \
                         *.java \
                         *.ii \
                         *.ixx \
                         *.ipp \
                         *.i++ \
                         *.inl \
                         *.h \
                         *.hh \
                         *.hxx \
                         *.hpp \
                         *.h++ \
                         *.idl \
                         *.odl \
                         *.cs \
                         *.php \
                         *.php3 \
                         *.inc \
                         *.m \
                         *.mm \
                         *.dox \
                         *.py \
                         *.f90 \
                         *.f \
                         *.vhd \
                         *.vhdl \
                         *.h.in \
                         *.h.default \
                         *.md

SOURCE_BROWSER          = YES
INLINE_SOURCES          = YES
STRIP_CODE_COMMENTS     = NO
REFERENCED_BY_RELATION  = YES
REFERENCES_RELATION     = YES
REFERENCES_LINK_SOURCE  = YES
VERBATIM_HEADERS        = YES

ALPHABETICAL_INDEX      = YES

GENERATE_HTML           = YES
HTML_OUTPUT             = html
HTML_FILE_EXTENSION     = .html
#HTML_ALIGN_MEMBERS      = YES
HTML_DYNAMIC_SECTIONS   = YES

#GENERATE_LATEX          = YES
#LATEXT_OUTPUT           = latex
#PDF_HYPERLINKS          = YES
#USE_PDFLATEX            = YES
#LATEX_BATCHMODE         = YES

DOCSET_FEEDNAME         = "WeatherStack Core Reference"

TOC_EXPAND              = YES

ENUM_VALUES_PER_LINE    = 1

GENERATE_TREEVIEW       = ALL

MACRO_EXPANSION         = YES
EXPAND_ONLY_PREDEF      = YES

SEARCH_INCLUDES         = YES

SKIP_FUNCTION_MACROS    = YES

#CLASS_DIAGRAMS          = YES
HIDE_UNDOC_RELATIONS    = YES

SEARCHENGINE            = NO

FULL_PATH_NAMES         = YES

OUTPUT_DIRECTORY        = docs
INPUT                   = include, src
EXCLUDE                 = build
RECURSIVE               = YES