From a8e3d5d5272dfa4b592dc663fb92a44f0b250f6e Mon Sep 17 00:00:00 2001 From: Jeff Teunissen Date: Thu, 16 Dec 2010 06:16:29 -0500 Subject: [PATCH] Doc fixes Tweak colors, add borders around some images, remove static definitions from engine docs. --- doc/Makefile.am | 3 +++ doc/doxygen.css | 62 ++++++++++++++++++++++++++----------------- doc/quakeforge.dox.in | 26 ++++++++++++------ ruamoko/Makefile.am | 3 +++ 4 files changed, 61 insertions(+), 33 deletions(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index 7a088f150..cf3e855e8 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -23,6 +23,9 @@ EXTRA_DIST= qf.ico \ @mkdir -p `dirname $@` fig2dev -L ps $< $@ +clean-local: + -rm -fr doxygen + progs/vm-mem.png: progs/vm-mem.fig progs/vm-mem.eps: progs/vm-mem.fig diff --git a/doc/doxygen.css b/doc/doxygen.css index dde158163..bfb6343c1 100644 --- a/doc/doxygen.css +++ b/doc/doxygen.css @@ -63,7 +63,7 @@ h3.version { } div.qindex, div.navtab{ - background-color: #262633; + background-color: #262833; border: 1px solid #9BA3C4; text-align: center; margin: 2px; @@ -144,9 +144,9 @@ dl.el { } pre.fragment { - border: 1px solid #BEC3D9; - background-color: #ccc; - color: #660066; + border: 1px solid #737b9c; + background-color: #dedfe5; + color: #4b5166; padding: 4px 6px; margin: 4px 8px 4px 2px; overflow: auto; @@ -196,8 +196,13 @@ div.contents { margin-right: 10px; } +/* inline MSC graphs? */ +.contents div img { + border: 2px solid #737b9c; +} + td.indexkey { - background-color: #262633; + background-color: #262833; font-weight: bold; border: 1px solid #737b9c; margin: 2px 0px 2px 0; @@ -205,14 +210,14 @@ td.indexkey { } td.indexvalue { - background-color: #262633; + background-color: #262833; border: 1px solid #737b9c; padding: 2px 10px; margin: 2px 0px; } tr.memlist { - background-color: #262633; + background-color: #262833; } p.formulaDsp { @@ -235,7 +240,8 @@ div.center { } div.center img { - border: 0px; + border: 2px solid #737b9c; + margin: 10px 2px; background-color: #bec3d9; } @@ -252,17 +258,17 @@ img.footer { /* @group Code Colorization */ span.keyword { - color: #000; + color: #262833; font-weight: bold; } span.keywordtype { - color: #000; + color: #262833; font-weight: bold; } span.keywordflow { - color: #000; + color: #000000; font-weight: bold; } @@ -332,14 +338,14 @@ td.tiny { } th.dirtab { - background: #E9EBF2; + background: #bdcaff; font-weight: bold; } hr { height: 0px; border: none; - border-top: 1px solid #4b4f66; + border-top: 1px solid #4b5166 } hr.footer { @@ -356,7 +362,7 @@ table.memberdecls { .mdescLeft, .mdescRight, .memItemLeft, .memItemRight, .memTemplItemLeft, .memTemplItemRight, .memTemplParams { - background-color: #262633; + background-color: #262833; border: none; margin: 4px; padding: 1px 0 0 8px; @@ -368,7 +374,7 @@ table.memberdecls { } .memItemLeft, .memItemRight, .memTemplParams { - border-top: 1px solid #BEC3D9; + border-top: 1px solid #bdcaff; } .memItemLeft, .memTemplItemLeft { @@ -388,13 +394,13 @@ table.memberdecls { .memtemplate { font-size: 80%; - color: #4b4f66; + color: #4b5166; font-weight: normal; margin-left: 3px; } .memnav { - background-color: #E9EBF2; + background-color: #bdcaff; border: 1px solid #9BA3C4; text-align: center; margin: 2px; @@ -412,6 +418,9 @@ table.memberdecls { font-weight: bold; margin-left: 6px; } +.memname a { + color: #ccccff; +} .memproto { border-top: 1px solid #A0A8C7; @@ -440,7 +449,7 @@ table.memberdecls { border-left: 1px solid #737b9c; border-right: 1px solid #737b9c; padding: 2px 5px; - background-color: #262633; + background-color: #262833; border-top-width: 0; /* firefox specific markup */ -moz-border-radius-bottomleft: 8px; @@ -461,6 +470,9 @@ table.memberdecls { .paramtype { white-space: nowrap; } +.paramtype a { + color: #ccccff; +} .paramname { color: #406; @@ -571,7 +583,7 @@ div.dynheader { address { font-style: normal; - color: #4b4f66; + color: #4b5166 } table.doxtable { @@ -579,7 +591,7 @@ table.doxtable { } table.doxtable td, table.doxtable th { - border: 1px solid #262633; + border: 1px solid #262833; padding: 3px 7px 2px; } @@ -598,7 +610,7 @@ table.doxtable th { height: 36px; /* background-image: url('tab_b.png');*/ background-color: #737b9c; - border-bottom: 2px solid #BEC3D9; + border-bottom: 2px solid #bdcaff; z-index: 101; overflow: hidden; font-size: 13px; @@ -612,7 +624,7 @@ table.doxtable th { height:30px; line-height:30px; color:#808BB5; - border:solid 1px #BCC1D7; + border:solid 1px #bdcaff; overflow:hidden; margin:0px; padding:0px; @@ -627,7 +639,7 @@ table.doxtable th { background-image:url('bc_s.png'); background-repeat:no-repeat; background-position:right; - color:#4b4f66; + color:#4b5166 } .navpath a @@ -640,7 +652,7 @@ table.doxtable th { .navpath a:hover { - color:#4b4f66; + color:#4b5166 } div.summary @@ -663,7 +675,7 @@ div.header background-repeat:repeat-x;*/ background-color: #737b9c; margin: 0px; - border-bottom: 2px solid #BEC3D9; + border-bottom: 2px solid #bdcaff; } div.headertitle diff --git a/doc/quakeforge.dox.in b/doc/quakeforge.dox.in index 3661f32e8..8da06ab3e 100644 --- a/doc/quakeforge.dox.in +++ b/doc/quakeforge.dox.in @@ -253,7 +253,7 @@ IDL_PROPERTY_SUPPORT = YES # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. -DISTRIBUTE_GROUP_DOC = YES +DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a @@ -308,7 +308,7 @@ EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. -EXTRACT_STATIC = YES +EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. @@ -373,13 +373,13 @@ INTERNAL_DOCS = NO # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. -CASE_SENSE_NAMES = YES +CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. -HIDE_SCOPE_NAMES = NO +HIDE_SCOPE_NAMES = YES # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation @@ -410,7 +410,7 @@ SORT_MEMBER_DOCS = YES # by member name. If set to NO (the default) the members will appear in # declaration order. -SORT_BRIEF_DOCS = NO +SORT_BRIEF_DOCS = YES # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen # will sort the (brief and detailed) documentation of class members so that @@ -420,7 +420,7 @@ SORT_BRIEF_DOCS = NO # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. -SORT_MEMBERS_CTORS_1ST = NO +SORT_MEMBERS_CTORS_1ST = YES # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) @@ -637,6 +637,8 @@ EXCLUDE += @TOPSRC@/libs/video/targets/fbset_modes_y.c EXCLUDE += @TOPSRC@/libs/video/targets/fbset_modes_y.h EXCLUDE += @TOPSRC@/tools/Forge EXCLUDE += @TOPSRC@/include/QF/GL +EXCLUDE += @TOPSRC@/include/block16.h +EXCLUDE += @TOPSRC@/include/block8.h # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded @@ -974,7 +976,7 @@ SEARCHENGINE = YES # full text search. The disadvances is that it is more difficult to setup # and does not have live searching capabilities. -SERVER_BASED_SEARCH = YES +SERVER_BASED_SEARCH = NO #--------------------------------------------------------------------------- # configuration options related to the LaTeX output @@ -1247,13 +1249,17 @@ SEARCH_INCLUDES = YES # the preprocessor. INCLUDE_PATH = @TOPSRC@/include +INCLUDE_PATH += @TOPSRC@/hw/include +INCLUDE_PATH += @TOPSRC@/nq/include +INCLUDE_PATH += @TOPSRC@/qw/include +INCLUDE_PATH += @TOPSRC@/qtv/include # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. -INCLUDE_FILE_PATTERNS = +INCLUDE_FILE_PATTERNS = *.h # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of @@ -1264,6 +1270,7 @@ INCLUDE_FILE_PATTERNS = # instead of the = operator. PREDEFINED = "__attribute__(x)=" +PREDEFINED += VISIBLE= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. @@ -1271,6 +1278,9 @@ PREDEFINED = "__attribute__(x)=" # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED += HAVE_FB_AUX_VGA_PLANES_VGA4 +EXPAND_AS_DEFINED += HAVE_FB_AUX_VGA_PLANES_CFB4 +EXPAND_AS_DEFINED += HAVE_FB_AUX_VGA_PLANES_CFB8 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone diff --git a/ruamoko/Makefile.am b/ruamoko/Makefile.am index c61e554ab..779fc1439 100644 --- a/ruamoko/Makefile.am +++ b/ruamoko/Makefile.am @@ -2,3 +2,6 @@ SUBDIRS= include lib game gui cl_menu scheme doc: Doxyfile doxygen + +clean-local: + -rm -fr doxygen