From c6a7fafada4d78e696162301617ac04725149d10 Mon Sep 17 00:00:00 2001 From: Harrand Date: Sun, 3 Nov 2024 16:26:22 +0000 Subject: [PATCH] [docs] improved doxygen layout and aesthetics --- README.md | 2 +- docs/Doxyfile | 22 +++++++++++----------- docs/DoxygenLayout.xml | 21 +++++++-------------- docs/tz.png | Bin 0 -> 3262 bytes include/tz/topaz.hpp | 2 +- 5 files changed, 20 insertions(+), 27 deletions(-) create mode 100644 docs/tz.png diff --git a/README.md b/README.md index bdee018cb2..5cb0371c49 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Topaz +# Topaz Engine [![OGL Debug](https://github.com/Harrand/Topaz/actions/workflows/codebuild_opengl_debug.yml/badge.svg)](https://github.com/Harrand/Topaz/actions/workflows/codebuild_opengl_debug.yml) [![OGL Release](https://github.com/Harrand/Topaz/actions/workflows/codebuild_opengl_release.yml/badge.svg)](https://github.com/Harrand/Topaz/actions/workflows/codebuild_opengl_release.yml) diff --git a/docs/Doxyfile b/docs/Doxyfile index f915be0447..9aad923522 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -60,13 +60,13 @@ PROJECT_BRIEF = "Topaz Game Engine" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = "./tz.png # With the PROJECT_ICON tag one can specify an icon that is included in the tabs # when the HTML document is shown. Doxygen will copy the logo to the output # directory. -PROJECT_ICON = +PROJECT_ICON = "./tz.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -673,7 +673,7 @@ SHOW_GROUPED_MEMB_INC = NO # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. -FORCE_LOCAL_INCLUDES = NO +FORCE_LOCAL_INCLUDES = YES # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. @@ -686,7 +686,7 @@ INLINE_INFO = YES # name. If set to NO, the members will appear in declaration order. # The default value is: YES. -SORT_MEMBER_DOCS = YES +SORT_MEMBER_DOCS = NO # If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member @@ -739,19 +739,19 @@ STRICT_PROTO_MATCHING = NO # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. -GENERATE_TODOLIST = YES +GENERATE_TODOLIST = NO # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. -GENERATE_TESTLIST = YES +GENERATE_TESTLIST = NO # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. -GENERATE_BUGLIST = YES +GENERATE_BUGLIST = NO # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in @@ -782,21 +782,21 @@ MAX_INITIALIZER_LINES = 30 # list will mention the files that were used to generate the documentation. # The default value is: YES. -SHOW_USED_FILES = YES +SHOW_USED_FILES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. -SHOW_FILES = YES +SHOW_FILES = NO # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. -SHOW_NAMESPACES = YES +SHOW_NAMESPACES = NO # The FILE_VERSION_FILTER tag can be used to specify a program or script that # Doxygen should invoke to get the current version for each file (typically from @@ -1444,7 +1444,7 @@ HTML_EXTRA_FILES = # The default value is: AUTO_LIGHT. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE = AUTO_LIGHT +HTML_COLORSTYLE = DARK # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to diff --git a/docs/DoxygenLayout.xml b/docs/DoxygenLayout.xml index d209561d5f..bd97f59023 100644 --- a/docs/DoxygenLayout.xml +++ b/docs/DoxygenLayout.xml @@ -2,14 +2,13 @@ - + - - + @@ -47,7 +46,6 @@ - @@ -68,7 +66,7 @@ - + @@ -85,7 +83,6 @@ - @@ -100,16 +97,15 @@ - + - - + @@ -131,7 +127,6 @@ - @@ -147,7 +142,7 @@ - + @@ -173,7 +168,6 @@ - @@ -198,12 +192,11 @@ - + - \ No newline at end of file diff --git a/docs/tz.png b/docs/tz.png new file mode 100644 index 0000000000000000000000000000000000000000..714168fce9401f541d6d50247caa7fb8f889b5be GIT binary patch literal 3262 zcmZuzdpwkB8y+1T#yX5&Joo!N_u;y(`+Z)f@BY0SaD6xo z2Gj8LARL6jl!%H`RT)^)lD-@PgWL!=H(yUTH%weY?D2@GFc=JXDdUo(hiH#M_YZz- zEUG?5JN~{e*OI~7<%MD&tq`Ip$u?~Z>ZP_O=36ghN8Y{rWB2tOcB4R3kd0YV8h`Vq zY8q?$+1gyln0wV~^v8S0_oGU#m0gD#BiH!aJ@n`frR`|>E~Nu|R$Ez{;6dYE@vuJr z%Kpy#v5A=@h2g2?%ZUr-sRc?-mrh-Hdyd%dvb!sC>zJIZ~Q;&2y(Y zdhHtP=GATRq(9d5-i$tDBuklJ_aEoA0TkH}(XhtyszDj$wd(Xs<*fo)X}ikd_b|5u zH;;K-cwKFdgm*4)%<$7hx351v_+pf@yek9t{j>fL8gX%|9F%$5$i#>v_x5TUum7c% zLw~|0S|U~iXi=u^+e?7W!`{H|oTOGp0*hLlM^GXRw$)g1DxJFOoC1t0NuEALmC5xw z2*Yo`SYx_@X=4&GFv%@8Iyx*S3Fej%MokJkhB+CLM91v)^zjYI($s^&;6lOjo_ruHgxG zu!5;0t6v>{Gg>k~l`21gc-cN@J;j;g-m(PI|9Mn>>@;niet9PIjNWX=TWP_R$f>%q zKy=b+@>bf?LjR4&uV&}iapiYMKVQ;qUo6?D?Z7bRat%Jq{ZeKdaw*95@t+D?Eg$Z5 zdOKTpZEG!d}}=^*I+W3Z#zDPpish+{p^SsLkdo{0@&Cu$gfp;e}#eONGPC_GyE zDTE_`7-Tq$8<`WF_M$5qNTT2PNc!8lZ+S!#Qk=NiF*S31?*=N8=wg5-@DtymP6rj0 z=aP`m4aF)snWs9E?LuWT=TB09ZLkpkl#}1I&58wKLO!sKrjQm3*KEL`>mKS;J(GlN z>v`2O4ue$rwSDhpEU4ceVSV;~^7*H`YktVc+iKVy;g>G5Vs`8JetrRxOg@He2+8a+a|gWj0; zv_92)W4EhIQuB5*cToR)*(}F~h0V#KCkxtKt<@yC0-Qh6!iOnIIsS`RxNCT+t`DoN zT1V>}w?W+Ll{XYgir}_uIk|0X5RX`Z6^B$9-GW1bnO+O7K{p@RSe^S3YAUI+5H8>L z6ru5~?A8LkJqt@w4;)_`*>k9sfp!dX`1|i!Su82+*I@R4@CERdY%Ygb*w=P~!CzGd@Ni~~6AuW@4Xbm>!7?2u*q0`e_ ziDR4$xtE^tDBO%=I50I{Hv8i8_KFS9ZCN}5W?0x7gj|ncpnH6vAsdDyB}P)xm)bRb zWjtMya*jZVUoS~fCJFIcno$39c!nofIT%tAaGoZ@;AJJ|-*MFptvGz5H1_fzh6Jt8 zT`X$Sfo&?`4#5?5338U%dB_~WtLdAS36j82};95=~#B zrH8=Aw%=x2s~ls}rp%@CN0jSV)NW4-=?B*p8xj|F?#127e_Zsjx_b1D-gvtg zKJqE0cN(y$lIV=6dCVjH`bfCTl9j!yC~dz}XtUbHMSxgg|MOMxrxyX=pxqadO8;y= z7))o=hvw170=L-FkfO=4rvakT%#}Zvy2}OhjI`ywkKI>;&aA97m5aiH?tJ>(^5tXV z(qF%!RVU)^J#1Kc^?l)=!=?#7AB2e=cvoV@|TQTC=g5P=M{EklyXKy0Bu^jvAJ? zhbCu+dU@NLQ!1%9*SdH&JEzM32OGg}y*m8#zHavhTkkexom$yDHE zo}ylf(&r}%Ffk2Im(h3S26l|g1O%o5kQ+fUSiv`ie||vWIym0A{byn8+ba6`b7_%t zoqy`O2%V-b@3?SeeR1S`MD0V_&D)n`^4;|0n7QY%cBbcwk+sr2g_v_e<#}@wgHx{? zb;Q?a607}(;nB&>_0?tL@Ct+S}ckH+)_p0jbRu2UOSOxxaM4>_`8 zlnw_@gxrMqbrO-FZD$l4ikJ&U8=lBBC;c6)t<C%G2N^+`w{j!A+1mc&0N(23Qh3ZncTR1qwYjNY(fb=qrI>kut$1Gz*J z;FCNh<|pQ3nuE)IIDy>t{|hvq52~^vPyI(L>ZCeN25M5nF07Rq<_zIky}V8Nl)F|< zrEu-C?S`fHKGcaM+n>jGG5-9|7vSgSMH%xRNb$AAMK@zF! zz(w%J*Mh$tqEpuSK{&XvD!5F5)LK|4QK7cuz189JJ^s7rJ`0+UL&D` z&J& zvne}~GY~&8QUn5~a5eRQ4qzdxu9%|!2J5+c$TD9MBlP;UxQlt~o>bpG~q(PH7?k}uy|E9$Zi;N|z@!)q1m#HBog6GVs4 zsNudxEy-!dizoQ=!pKlBMRU4ngNc5*^-n6uV_!N{p^qh=d?5<|@+;zI`#G9T4c{As z-S&Qy!HJ*g$?nJ?YF>|=0|3uv0Kog(_eVXD?|yen0bDWK0{!7D^tlL-ShH5>A__me zsTt^@LMPvki5;NV^gxvOr`wdf#x&j>-eyngKe%Gs38cq2dz#>7@w+@+fFpF17m@*4dvr zbfy5P9_zy+=2J>^5JW0L8$lHKfAF=)_uB%3`Y;*TE*yh_%@GC8Cewn`2ZOYUhz+57 z4jnT9Nrnv;xQq5D(_@F+k<`tK#L098Wi~~D6@!Nr+-%!MQQQ#jiYyF!YVs+ybDhl? z7S^mspt%k~I@YrQ)cNE?-O0#Z$<=eN2In^pnN z1msxd+F#B-T(S85J9o!A^cc>cfN;$vY1e~o6?^vMMhjv8#schF+!_WpJ#Ol&?!f3t zmRl`DLg_M#Sq`T2x0?}Rq^gR+oXJ~1d>#DTp7ifFU(uOYj%q(=ygWOvnBYm=PY}2s&HgVhmAN?p literal 0 HcmV?d00001 diff --git a/include/tz/topaz.hpp b/include/tz/topaz.hpp index 244ab243c3..fb8343e6fa 100644 --- a/include/tz/topaz.hpp +++ b/include/tz/topaz.hpp @@ -3,7 +3,7 @@ #include "textc/imported_text.hpp" /** - * @defgroup tz Topaz API Reference + * @defgroup tz API Reference **/ namespace tz {