G4OCCT/Doxyfile at main · eic/G4OCCT · 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
# SPDX-License-Identifier: LGPL-2.1-or-later
# Copyright (C) 2026 G4OCCT Contributors
#
# Doxygen configuration for G4OCCT.
# Run:  doxygen Doxyfile
# Output is written to docs/api/

PROJECT_NAME           = "G4OCCT"
PROJECT_NUMBER         = 0.1.0
PROJECT_BRIEF          = "Geant4 interface to Open CASCADE Technology (OCCT) geometry definitions"
PROJECT_LOGO           =

OUTPUT_DIRECTORY       = docs/api
CREATE_SUBDIRS         = NO
OUTPUT_LANGUAGE        = English

# ── Input ─────────────────────────────────────────────────────────────────────
USE_MDFILE_AS_MAINPAGE = README.md
INPUT                  = README.md include src
FILE_PATTERNS          = *.hh *.cc *.md
RECURSIVE              = YES
EXCLUDE_PATTERNS       = */tests/* */benchmarks/*

# ── Extraction ────────────────────────────────────────────────────────────────
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = YES

# ── Source browsing ───────────────────────────────────────────────────────────
SOURCE_BROWSER         = YES
INLINE_SOURCES         = NO
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES

# ── HTML output ───────────────────────────────────────────────────────────────
GENERATE_HTML          = YES
HTML_OUTPUT            = .
HTML_FILE_EXTENSION    = .html
GENERATE_TREEVIEW      = YES

# ── LaTeX output (disabled) ───────────────────────────────────────────────────
GENERATE_LATEX         = NO

# ── Preprocessor ──────────────────────────────────────────────────────────────
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = NO

# ── Diagrams ──────────────────────────────────────────────────────────────────
HAVE_DOT               = NO
CLASS_DIAGRAMS         = YES

# ── Warnings ──────────────────────────────────────────────────────────────────
WARNINGS               = YES
WARN_IF_UNDOCUMENTED   = YES
WARN_NO_PARAMDOC       = NO