Skip to content

Commit 2e53216

Browse files
committed
docs: add Doxygen configuration file
- Create comprehensive Doxyfile for API documentation generation - Configure for SQL file parsing (treated as C++ for Doxygen) - Enable HTML output to docs/api directory - Exclude test files and build artifacts - Add docs/api/ to .gitignore for generated documentation To generate documentation: doxygen Doxyfile Output will be in docs/api/html/index.html
1 parent 1264b71 commit 2e53216

File tree

2 files changed

+143
-0
lines changed

2 files changed

+143
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ deps-ordered-supabase.txt
1313

1414
src/version.sql
1515

16+
# Doxygen generated documentation
17+
docs/api/
18+
1619

1720

1821
# Logs

Doxyfile

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Doxyfile for Encrypt Query Language (EQL)
2+
# PostgreSQL extension for searchable encryption
3+
4+
#---------------------------------------------------------------------------
5+
# Project Settings
6+
#---------------------------------------------------------------------------
7+
8+
PROJECT_NAME = "Encrypt Query Language (EQL)"
9+
PROJECT_NUMBER = "2.x"
10+
PROJECT_BRIEF = "PostgreSQL extension for searchable encryption"
11+
PROJECT_LOGO =
12+
13+
OUTPUT_DIRECTORY = docs/api
14+
CREATE_SUBDIRS = NO
15+
16+
#---------------------------------------------------------------------------
17+
# Build Settings
18+
#---------------------------------------------------------------------------
19+
20+
GENERATE_HTML = YES
21+
GENERATE_LATEX = NO
22+
GENERATE_XML = NO
23+
GENERATE_MAN = NO
24+
25+
HTML_OUTPUT = html
26+
HTML_FILE_EXTENSION = .html
27+
HTML_COLORSTYLE_HUE = 220
28+
HTML_COLORSTYLE_SAT = 100
29+
HTML_COLORSTYLE_GAMMA = 80
30+
HTML_TIMESTAMP = YES
31+
HTML_DYNAMIC_SECTIONS = YES
32+
33+
#---------------------------------------------------------------------------
34+
# Input Settings
35+
#---------------------------------------------------------------------------
36+
37+
INPUT = src/
38+
FILE_PATTERNS = *.sql *.template
39+
RECURSIVE = YES
40+
EXCLUDE_PATTERNS = *_test.sql \
41+
*/release/* \
42+
*/tests/* \
43+
.git/* \
44+
*/.worktrees/*
45+
46+
# Treat SQL files as C++ for parsing
47+
EXTENSION_MAPPING = sql=C++ template=C++
48+
49+
#---------------------------------------------------------------------------
50+
# Extraction Settings
51+
#---------------------------------------------------------------------------
52+
53+
EXTRACT_ALL = NO
54+
EXTRACT_PRIVATE = NO
55+
EXTRACT_STATIC = YES
56+
EXTRACT_LOCAL_CLASSES = YES
57+
EXTRACT_ANON_NSPACES = NO
58+
59+
HIDE_UNDOC_MEMBERS = NO
60+
HIDE_UNDOC_CLASSES = NO
61+
HIDE_IN_BODY_DOCS = NO
62+
63+
#---------------------------------------------------------------------------
64+
# Preprocessing
65+
#---------------------------------------------------------------------------
66+
67+
ENABLE_PREPROCESSING = NO
68+
MACRO_EXPANSION = NO
69+
EXPAND_ONLY_PREDEF = NO
70+
71+
#---------------------------------------------------------------------------
72+
# Documentation Settings
73+
#---------------------------------------------------------------------------
74+
75+
JAVADOC_AUTOBRIEF = YES
76+
QT_AUTOBRIEF = NO
77+
MULTILINE_CPP_IS_BRIEF = NO
78+
79+
TAB_SIZE = 2
80+
OPTIMIZE_OUTPUT_FOR_C = YES
81+
OPTIMIZE_OUTPUT_JAVA = NO
82+
83+
BUILTIN_STL_SUPPORT = NO
84+
CPP_CLI_SUPPORT = NO
85+
SIP_SUPPORT = NO
86+
IDL_PROPERTY_SUPPORT = YES
87+
88+
#---------------------------------------------------------------------------
89+
# Warning and Progress Settings
90+
#---------------------------------------------------------------------------
91+
92+
QUIET = NO
93+
WARNINGS = YES
94+
WARN_IF_UNDOCUMENTED = YES
95+
WARN_IF_DOC_ERROR = YES
96+
WARN_NO_PARAMDOC = YES
97+
WARN_AS_ERROR = NO
98+
WARN_FORMAT = "$file:$line: $text"
99+
100+
#---------------------------------------------------------------------------
101+
# Source Browsing
102+
#---------------------------------------------------------------------------
103+
104+
SOURCE_BROWSER = YES
105+
INLINE_SOURCES = NO
106+
STRIP_CODE_COMMENTS = NO
107+
REFERENCED_BY_RELATION = YES
108+
REFERENCES_RELATION = YES
109+
VERBATIM_HEADERS = YES
110+
111+
#---------------------------------------------------------------------------
112+
# Alphabetical Index
113+
#---------------------------------------------------------------------------
114+
115+
ALPHABETICAL_INDEX = YES
116+
COLS_IN_ALPHA_INDEX = 5
117+
118+
#---------------------------------------------------------------------------
119+
# Graph Generation
120+
#---------------------------------------------------------------------------
121+
122+
HAVE_DOT = NO
123+
CLASS_DIAGRAMS = NO
124+
COLLABORATION_GRAPH = NO
125+
GROUP_GRAPHS = NO
126+
INCLUDE_GRAPH = NO
127+
INCLUDED_BY_GRAPH = NO
128+
CALL_GRAPH = NO
129+
CALLER_GRAPH = NO
130+
GRAPHICAL_HIERARCHY = NO
131+
DIRECTORY_GRAPH = NO
132+
DOT_IMAGE_FORMAT = png
133+
INTERACTIVE_SVG = NO
134+
135+
#---------------------------------------------------------------------------
136+
# Search Engine
137+
#---------------------------------------------------------------------------
138+
139+
SEARCHENGINE = YES
140+
SERVER_BASED_SEARCH = NO

0 commit comments

Comments
 (0)