From a73a67d252678fafc7cfbb8cb0333434b01af01c Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Sun, 5 Oct 2025 19:59:58 -0700 Subject: [PATCH] doxygen improvements --- Doxyfile | 45 ++++++++++++++++++ DoxygenLayout.xml | 28 ++--------- dist/doxygen/favicon.png | Bin 0 -> 1562 bytes dist/doxygen/ghostty.css | 99 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 147 insertions(+), 25 deletions(-) create mode 100644 dist/doxygen/favicon.png create mode 100644 dist/doxygen/ghostty.css diff --git a/Doxyfile b/Doxyfile index fccd4a493..d0c0414dc 100644 --- a/Doxyfile +++ b/Doxyfile @@ -2,9 +2,38 @@ DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "libghostty" +PROJECT_LOGO = images/gnome/64.png INPUT = include/ghostty/vt.h INPUT_ENCODING = UTF-8 RECURSIVE = NO +FULL_PATH_NAMES = NO +STRIP_FROM_INC_PATH = include +SOURCE_BROWSER = YES +INLINE_SOURCES = NO +REFERENCES_RELATION = YES +REFERENCED_BY_RELATION = YES + +#--------------------------------------------------------------------------- +# C API Optimization +#--------------------------------------------------------------------------- + +# Optimize output for C API documentation +OPTIMIZE_OUTPUT_FOR_C = YES +TYPEDEF_HIDES_STRUCT = YES +HIDE_SCOPE_NAMES = YES + +# Clean path names +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = . +STRIP_FROM_INC_PATH = include + +# Hide undocumented and internal APIs +HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_CLASSES = YES +EXTRACT_ALL = NO +INTERNAL_DOCS = NO +EXTRACT_PRIVATE = NO +EXTRACT_LOCAL_CLASSES = NO #--------------------------------------------------------------------------- # HTML Output @@ -12,6 +41,21 @@ RECURSIVE = NO GENERATE_HTML = YES HTML_OUTPUT = zig-out/share/ghostty/doc/libghostty +HTML_EXTRA_STYLESHEET = dist/doxygen/ghostty.css +HTML_EXTRA_FILES = dist/doxygen/favicon.png +HTML_COLORSTYLE = DARK +LAYOUT_FILE = DoxygenLayout.xml +GENERATE_TREEVIEW = YES +HTML_DYNAMIC_SECTIONS = YES +SEARCHENGINE = YES +ALPHABETICAL_INDEX = YES +HTML_TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Graphs and Diagrams +#--------------------------------------------------------------------------- + +HAVE_DOT = NO #--------------------------------------------------------------------------- # Man Output @@ -20,6 +64,7 @@ HTML_OUTPUT = zig-out/share/ghostty/doc/libghostty GENERATE_MAN = YES MAN_OUTPUT = zig-out/share/man MAN_EXTENSION = .3 +MAN_LINKS = YES #--------------------------------------------------------------------------- # Other Output diff --git a/DoxygenLayout.xml b/DoxygenLayout.xml index 67497e83f..ae9c52684 100644 --- a/DoxygenLayout.xml +++ b/DoxygenLayout.xml @@ -6,37 +6,15 @@ - + - - - - - - - - - - - - - - - - - - + - - - - - - + diff --git a/dist/doxygen/favicon.png b/dist/doxygen/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..b647bcf358546e6f9b54c9c423579db9205f2bcc GIT binary patch literal 1562 zcmV+#2IcvQP)A#`s<*=)YsQ{)B5%6hXw`)-q+sVUKWwiT8oGXAiiystqZVz zkj~G~S5BQeb>`5aLnCL;o_+he0e0-z@x9^U;co%K#fy`~am`N)jlLF(AT(2j3EnB|!-R}&u_a{#k@Rws_V{cqFfy0Ln|LX2ltG;m4vSoBG zy_>;RU*_Dz4E?t+=ib$~5~zST#{S7`e>}zFMMc`82xDn10vbk$3V?{Q(F6SF+#eVp zKf~zgi9_qwt=n+b1p52?2Y>tOaR7Sz?%?!WZ}PeOKf%s#f0A}jTcw{T_LbTD^JnQ< z7(wnSz9w=SH!c**EL!@02k^UBU*>~%-Zj{C3(_<#)r$^ba%PfyKDv_6tX;{!XDvDq zk_2w7B)Uqib_sx~sf(B_D>Vg(<5=lL128{7 z$Lcj7V|M-$9~s!dBYS>`GATcP={MZ_+57nT+BF<~;V9L34iH}x`6+aL0Yrt=lFNWl zpSxPCsipwcYE{LtFSepkqsUxb<>uu}n72igjR?w%nNHfs!hnti5%X67u?kV*mrdRR z1fh_mDF9mQx`%BAfKC!XNV9~Q=^3ia`}oGbXNVP~8g5&CJ5dO~Kl(RBidYID3Q!>a zUXc7;pwow0VGL+P7@#?H34&%FVnuHm$xr~Xiy3&m!PW$3hS zj3x*pL*E(fu^<*uC}J{{+k%z=wK(uI^g?D3EKZob=ids+;F7nw@| z2@y$r0*R}cRsc3l-N%TO5sAR2SQn$p0i2Zh;aZyQFvkTmyZZen1=Y3??-rIlH@wJKqo!{2M}PzuM}}c4!{b4AG_@HG1vxk zKq3UeUqp2PX_bKc$N{JVA`0NV8e`B}r%eGWmCEG8&fZ(#1lFcV(1XpU0cmcIZ2+=(<+UI| zHzZTQ1f5+Ua2`zoPM$n@?9=ys>cfE?A^z8X)Ut0P;f-LkhCNk{9u4mWe0n*8D6EO8 zoqrld#;v!l76a2)O#qla@bptd4?g(SV-G*Pnb-gHB2!Z*Fqy?Ro_FwLT0jXwAoTRy zz+J08PgLw+-%t0hb>__z@Kj+qI5af0ZN-WeYr-%nTWj(D{!d5V36Q@N5zkQXE7B~R z9UmV*J~A@$XqIJvX@cBT?