Skip to content

Commit 8d2894f

Browse files
committed
Add Doxygen configuration
1 parent 324aea0 commit 8d2894f

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,6 @@ coverage.info
3636
coverage_report/
3737

3838
.vscode
39+
40+
# Doxygen
41+
docs/output

docs/Doxyfile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
PROJECT_NAME = LiveKit ESP-32 SDK
2+
OUTPUT_DIRECTORY = ./output
3+
OPTIMIZE_OUTPUT_FOR_C = YES
4+
WARN_IF_UNDOCUMENTED = YES
5+
INPUT = ../README.md \
6+
../docs \
7+
../components/livekit/include \
8+
../components/livekit_sandbox/include
9+
USE_MDFILE_AS_MAINPAGE = ../README.md
10+
FILE_PATTERNS = *.h *.md
11+
EXTRACT_ALL = YES
12+
RECURSIVE = YES
13+
JAVADOC_AUTOBRIEF = YES
14+
GENERATE_LATEX = NO
15+
GENERATE_HTML = YES
16+
TIMESTAMP = YES
17+
INLINE_SIMPLE_STRUCTS = YES
18+
TYPEDEF_HIDES_STRUCT = YES
19+
SHOW_FILES = NO
20+
LAYOUT_FILE = ./layout.xml

docs/layout.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<doxygenlayout version="2.0">
3+
<!-- Generated by doxygen 1.14.0 -->
4+
<!-- Navigation index tabs for HTML output -->
5+
<navindex>
6+
<tab type="mainpage" visible="yes" title="Introduction"/>
7+
<tab type="topics" visible="yes" title="API Reference" intro=""/>
8+
<tab type="pages" visible="yes" title="Guides" intro=""/>
9+
</navindex>
10+
</doxygenlayout>

0 commit comments

Comments
 (0)