mirrors/ghostty
1
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2025-10-02 16:08:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

setup basic doxygen for docs

Browse Source 
We may not stick with Doxygen, but it gives us something to start with.
This commit is contained in:
Mitchell Hashimoto
2025-09-23 15:26:06 -07:00
parent def4969aff
commit 32bf37e5e4
3 changed files with 33 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
Doxyfile Normal file
View File

@@ -0,0 +1,28 @@
# Doxyfile 1.13.2
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "libghostty"
INPUT = include/ghostty-vt.h
INPUT_ENCODING = UTF-8
RECURSIVE = NO
#---------------------------------------------------------------------------
# HTML Output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = zig-out/share/ghostty/doc/libghostty
#---------------------------------------------------------------------------
# Man Output
#---------------------------------------------------------------------------
GENERATE_MAN = YES
MAN_OUTPUT = zig-out/share/man
MAN_EXTENSION = .3
#---------------------------------------------------------------------------
# Other Output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO

2
nix/devShell.nix
View File

@@ -3,6 +3,7 @@
lib,
stdenv,
bashInteractive,
doxygen,
nushell,
appstream,
flatpak-builder,
@@ -89,6 +90,7 @@ in
packages =
[
# For builds
doxygen
jq
llvmPackages_latest.llvm
minisign

6
src/lib_vt.zig
View File

@@ -66,9 +66,9 @@ pub const TabClear = terminal.TabClear;
pub const Attribute = terminal.Attribute;
comptime {
if (terminal.is_c_lib) {
_ = terminal.c_api;
}
// If we're building the C library (vs. the Zig module) then
// we want to reference the C API so that it gets exported.
if (terminal.is_c_lib) _ = terminal.c_api;
}
test {