mirror of
https://github.com/ghostty-org/ghostty.git
synced 2025-10-02 16:08:39 +00:00
setup basic doxygen for docs
We may not stick with Doxygen, but it gives us something to start with.
This commit is contained in:
28
Doxyfile
Normal file
28
Doxyfile
Normal 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
|
@@ -3,6 +3,7 @@
|
|||||||
lib,
|
lib,
|
||||||
stdenv,
|
stdenv,
|
||||||
bashInteractive,
|
bashInteractive,
|
||||||
|
doxygen,
|
||||||
nushell,
|
nushell,
|
||||||
appstream,
|
appstream,
|
||||||
flatpak-builder,
|
flatpak-builder,
|
||||||
@@ -89,6 +90,7 @@ in
|
|||||||
packages =
|
packages =
|
||||||
[
|
[
|
||||||
# For builds
|
# For builds
|
||||||
|
doxygen
|
||||||
jq
|
jq
|
||||||
llvmPackages_latest.llvm
|
llvmPackages_latest.llvm
|
||||||
minisign
|
minisign
|
||||||
|
@@ -66,9 +66,9 @@ pub const TabClear = terminal.TabClear;
|
|||||||
pub const Attribute = terminal.Attribute;
|
pub const Attribute = terminal.Attribute;
|
||||||
|
|
||||||
comptime {
|
comptime {
|
||||||
if (terminal.is_c_lib) {
|
// If we're building the C library (vs. the Zig module) then
|
||||||
_ = terminal.c_api;
|
// we want to reference the C API so that it gets exported.
|
||||||
}
|
if (terminal.is_c_lib) _ = terminal.c_api;
|
||||||
}
|
}
|
||||||
|
|
||||||
test {
|
test {
|
||||||
|
Reference in New Issue
Block a user