mxl/Doxyfile.in at main · aguo-RV/mxl · 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
# SPDX-FileCopyrightText: 2025 Contributors to the Media eXchange Layer project.
# SPDX-License-Identifier: Apache-2.0

# Doxyfile configuration for generating documentation for C, C++, and .h files
# located in the lib/ and mxlapp/ subdirectories.

# Project settings
PROJECT_NAME           = "MXL : Media eXchange Layer"
PROJECT_BRIEF          = "MXL"
OUTPUT_DIRECTORY       = docs
OUTPUT_LANGUAGE        = English

# Input settings
INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/README.md @CMAKE_CURRENT_SOURCE_DIR@/lib
FILE_PATTERNS          = *.c *.cpp *.h *.hpp *.md
RECURSIVE              = YES
USE_MDFILE_AS_MAINPAGE = README.md

# Build settings
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = YES

# Source browsing settings
SOURCE_BROWSER         = YES
INLINE_SOURCES         = YES

# Documentation generation format (HTML enabled by default)
GENERATE_HTML          = YES
HTML_OUTPUT            = html

# Optional: Enable LaTeX or other formats as needed
GENERATE_LATEX         = NO
GENERATE_XML           = NO
GENERATE_MAN           = NO
GENERATE_RTF           = NO

# Warnings and diagnostics
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_NO_PARAMDOC       = YES

# Additional options (optional)
SHOW_USED_FILES        = YES
SHOW_FILES             = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = YES
SORT_BY_SCOPE_NAME     = YES

GENERATE_TREEVIEW      = YES
DISABLE_INDEX          = NO
FULL_SIDEBAR           = NO
HTML_EXTRA_STYLESHEET  = @AWESOME_CSS_DIR@/doxygen-awesome.css
HTML_COLORSTYLE        = LIGHT
GENERATE_TODOLIST      = YES