From fe79411ba240822e8860eba1cf50674963e3ccdd Mon Sep 17 00:00:00 2001 From: Oliver Bock <oliver.bock@aei.mpg.de> Date: Thu, 3 Jul 2008 14:43:10 +0200 Subject: [PATCH] Improved overall documentation style * Logos at the top * Proper stylesheet (better heading handling) * Added LSC logo --- Doxyfile | 8 +- doc/default/footer.html | 6 +- doc/default/header.html | 15 ++- doc/default/lsc.gif | Bin 0 -> 2012 bytes doc/default/stylesheet.css | 268 ++++++++++++++++++++++++++----------- 5 files changed, 212 insertions(+), 85 deletions(-) create mode 100644 doc/default/lsc.gif diff --git a/Doxyfile b/Doxyfile index d363eae..8ec9984 100644 --- a/Doxyfile +++ b/Doxyfile @@ -31,7 +31,7 @@ PROJECT_NAME = "Einstein@Home Graphics Application" # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 0.2.0 +PROJECT_NUMBER = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. @@ -505,7 +505,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = *.svn *CVS +EXCLUDE = *.svn *CVS # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded @@ -684,7 +684,7 @@ HTML_FILE_EXTENSION = .html # each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = +HTML_HEADER = doc/default/header.html # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a @@ -699,7 +699,7 @@ HTML_FOOTER = doc/default/footer.html # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = +HTML_STYLESHEET = doc/default/stylesheet.css # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to diff --git a/doc/default/footer.html b/doc/default/footer.html index 570bf95..1139b91 100644 --- a/doc/default/footer.html +++ b/doc/default/footer.html @@ -1,9 +1,9 @@ <hr size="1"> <table col="3" width="100%"> <tr> - <td width="300"><a href="http://www.aei.mpg.de"><img src="aei_full.png" alt="Albert-Einstein-Institute" align="left" border="0"></a></td> - <td width="*"><p align="center">Generated on $datetime</p></td> - <td width="300"><a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="right" border="0"></a></td> + <td width="250"><p align="left">Generated on $datetime</p></td> + <td width="*"> </td> + <td width="250"><a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="right" border="0"></a></td> <tr> </table> </body> diff --git a/doc/default/header.html b/doc/default/header.html index 7c427c0..1369a9b 100644 --- a/doc/default/header.html +++ b/doc/default/header.html @@ -1,6 +1,15 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=utf-8"> <title>$title</title> -<link href="$relpath$doxygen.css" rel="stylesheet" type="text/css"> +<link href="$relpath$stylesheet.css" rel="stylesheet" type="text/css"> <link href="$relpath$tabs.css" rel="stylesheet" type="text/css"> -</head><body> +</head> +<body> +<table col="3" width="100%"> + <tr> + <td width="300"><a href="http://www.ligo.org"><img src="lsc.gif" alt="LIGO Scientific Collaboration" align="left" border="0"></a></td> + <td width="*" valign="middle"><h1>Einstein@Home<br>(Graphics Application Framework)</h1></td> + <td width="300"><a href="http://www.aei.mpg.de"><img src="aei_full.png" alt="Albert-Einstein-Institute" align="right" border="0"></a></td> + <tr> +</table> +<br> diff --git a/doc/default/lsc.gif b/doc/default/lsc.gif new file mode 100644 index 0000000000000000000000000000000000000000..deeb89367e58afef20629ca9e06c7b1864e6b61c GIT binary patch literal 2012 zcmZ?wbhEHbT)^PMaFv1K|NsA=e*S;<`TvIxpKreTfA-n`2M?a@zyE*p&HooJ++23~ z|I9Q04;(n#d+dMx{{Id8|8LlEpm^v1&XrfvHveC+U~}Y}|9%U;_4hAznE&5+=KqF< znNIzW>g#73^ncQAds<M?t5<zVv*xB+@!5og2Ib8CYH2$Z5;g|}6w8J!mGqhE;E*Qf z+#_t&AZ%H0U=S%_P|T~As-WP@DHF*i>?0uHz|7^qz+lXP8z}x{VHIIuV9)_60r`o6 z?Y~1qfW?j#8QYc=oy@VCe_=(5*V?G{Ub9{qNmT8ZQ7QA$n|=O;YVYT-d~Ppy)cC3Q z?|K_td;a}(|6HlM46W9-=E%0zq>ezTydH05o+(qO=+&91i}U2haf&EUOgB^(;hg8h zBVN_(Yf`}=?%zL8tHw}d<!%On?P-(u<T8sGuJaam-tW6L_jK{eLwf`khp4k%+AVUm zPRsd@+1dE>nI<c4?qQn|Y9jDr5A*9@6X$?OaZfUyzu(RLz(?=fM{m~Sp|(*gKh4}} zzJa${Q!mNXM>YR~qdHHkh6=NG=tN=B(3%%pRzDDyx>2Tjp}?iHOYmKp<PY=bN}F4X z?3UaTd+N99KTBXzmDdKtPVPzbSQIy%R8ekN6wy*uX_0zFFWHab?UI!))79&}TW=he zWM3)1G?=9-^Qua!G*|eNs-FU42O^@2&hRa?a!n6X53@bHN9gfs1~#47_e#~&Z$)cG z@f1$AKC(oVYqeWQNRL3iO#Vuqm>V@|;@6WyX6O}iiFV&g6tLSejp>%+E0a}IH_Ut7 zG@p^9bG?OY^=_YcD!ZSv<ehlH9H!Z~KSIy$S%t->Q>uJE275c>Qm>qi@b^<cR(?Nc zZ*qQ!vs>oIxssm?9UZOrNBW(!|GIh6$sQ4733hq6*B>{Y%)WVG>AdusD-)Wkebyv6 z@m}Sv5N_^Wv4D{!&vWwsIH6yq;cmP-7K)0k-Ul8y)`$0mKQN5SSa4r}Ek@#m44=~u z7jC%&2U>V!I~tONRQOJ|bW60kH?w`?{rIpb-r<0th1!%8E?klkD_JJU{@BsNsc+G^ zq^8KljHxhq!4$4pduv_W{In+qH?v1+2|7*l*)oA~Uc6t$l2+fn7RLhT)o8Fz3En!j zYhiGSg+orn+6j%*y$)<x-sd@CL;75^jt7j(lKX^@`-NZm#v1SCGW~^U2Or}U-f5FA zw6IH795}*Loz{@aD_bIvCbaO8Fnbfj1h&@rZH9pnS|uAVt1z66n&l`wEA0Z4u-coK zjT7~AxO5h*=Coql6t7Y+i#O}v)&DKw^E!TTZA`eS@N!G|J546xyYD)ggq13!bt<0P z%sx=;f5hQU-Fh2sZePZ?mvq)kp6JS5=W}I3Hk+H5^~?QICm&7`5Ybq|w7bbM@s+`1 z(?X_`xqGslw@$g`X(%kdc?HW_$r1sE9lLy0c!ZyMOm<L}ea95KdR|D;2Z4__0-X0t zzNyY$Cu>spaj$p6&U6+V<>$uwzAj(3s{i<EvMq7Oh6@MhX<7v4vZ+P*nhHy$2Q<Wf zocp#_IO#QSLsRgI3rEkzA3w}=PVvYZmwnY*dWVmG(Ml{_C;Y&7!ToA$$HP4@_7t-6 z?h+|*U~E||+`yu`X09X0bt}e{brJf8@6UKU`29bSG$Z<53)h_Qhc8R)WKd{e;<eat z;03FIfeYgz{Ra)KJKH`eh^&8qvvH#5gFWdSMbCFJyqn>yl5ED-Qj{lRa^Q+9;}L%Y z#wU_F3{9Mx2O4UHH$U&m6sn5T+4^L{Y=?>!51OWDJZNB_ayI9b0P{qJ0On1GVIpY^ zrnzs=XWq(|xvS9L$XF#HXnf+@)py^GP8{{)jM{yJUD}ZO=ubyBr8866>#nv)JUi7| z-gJj6@&uFAyF@na6N*=Z9Gs+Y1jPHUxINEmhqKtS11#D*6eP1gFo~oTRIe>|;=RXa ztsXL=$k*j8w~v5|$d&W0ei@3~K@T*4tj%L(Tr^K$ak>4m*#B>;6ZiD;ggG?vbUo;A z$XP6%*xn>A5?G|UM}qSmyWx+!di@VqGV(-CU=sQhSgQ6XnJef6lcwFng1jw~`|m_p zddxE7)8Fyv+l7oHj`!Y9NzUlk%-+Bh`fN?EzeUoz9m}jE!V=kRa~^T;;ILG(OYCmG z5_!EwvsH4z0<S_B-p&&<d>9-P*@|0ac-9>D(Y&&NRgr^{D?;F`{3Zt0n=LY&n|`#2 zCJ5DCf0SmvoZ*P|)IwGR4Rx`o9ZVt}59a2HFv`sS=~_{@div)%k0gvGRDAP3Efh$7 ztjf;0U!dXTgbtP$M{Ab0<g0AqG)iD}+se`Gb!*ZhjaXSu3(HHYD|nawoPUbxfZeVZ zsSE3uUeSIj{C|eujlUD?etbz0ky#RWV&MUgt(wxl(<gWdbC~uU=)5{wb%o{lk?fVG zzK-lp1_8lLAD2j*s$EcNQd^^@*mB$XU~s=8bICH3@VZ@hqRz~6TN~BS5_m;feks>} zz7A9E_`>Ot`)B%gKN4OZHepE%*RQZ^iC5IKt>T?-R|T~{5@!3>%#@b6p~?5($F<F0 z7`VRt?CLi>%Q0#0a-N_I!54O2+Zq$QT5QLJ-M4N{6KAw=VAlF@>t4_nCSD7NmwDcI z9@X{M^3PyktC=0d<FkN~W5?{m<=(M-SsN<3BOHqEZolKW>;2A~sd1%@0xS&H09P<+ AI{*Lx literal 0 HcmV?d00001 diff --git a/doc/default/stylesheet.css b/doc/default/stylesheet.css index c7db1a8..750e50c 100644 --- a/doc/default/stylesheet.css +++ b/doc/default/stylesheet.css @@ -2,19 +2,24 @@ BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { font-family: Geneva, Arial, Helvetica, sans-serif; } BODY,TD { - font-size: 90%; + font-size: 90%; } H1 { text-align: center; font-size: 160%; } H2 { - font-size: 120%; + font-size: 130%; } H3 { + font-size: 115%; +} +H4 { font-size: 100%; } -CAPTION { font-weight: bold } +CAPTION { + font-weight: bold +} DIV.qindex { width: 100%; background-color: #e8eef2; @@ -24,7 +29,7 @@ DIV.qindex { padding: 2px; line-height: 140%; } -DIV.nav { +DIV.navpath { width: 100%; background-color: #e8eef2; border: 1px solid #84b0c7; @@ -70,15 +75,43 @@ A.qindexHL:hover { background-color: #6666cc; color: #ffffff; } -A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff } -A.el { text-decoration: none; font-weight: bold } -A.elRef { font-weight: bold } -A.code:link { text-decoration: none; font-weight: normal; color: #0000FF} -A.code:visited { text-decoration: none; font-weight: normal; color: #0000FF} -A.codeRef:link { font-weight: normal; color: #0000FF} -A.codeRef:visited { font-weight: normal; color: #0000FF} -A:hover { text-decoration: none; background-color: #f2f2ff } -DL.el { margin-left: -1cm } +A.qindexHL:visited { + text-decoration: none; + background-color: #6666cc; + color: #ffffff +} +A.el { + text-decoration: none; + font-weight: bold +} +A.elRef { + font-weight: bold +} +A.code:link { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.code:visited { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.codeRef:link { + font-weight: normal; + color: #0000FF +} +A.codeRef:visited { + font-weight: normal; + color: #0000FF +} +A:hover { + text-decoration: none; + background-color: #f2f2ff +} +DL.el { + margin-left: -1cm +} .fragment { font-family: monospace, fixed; font-size: 95%; @@ -95,7 +128,13 @@ PRE.fragment { padding-top: 4px; padding-bottom: 4px; } -DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +DIV.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} DIV.groupHeader { margin-left: 16px; @@ -103,7 +142,11 @@ DIV.groupHeader { margin-bottom: 6px; font-weight: bold; } -DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% } +DIV.groupText { + margin-left: 16px; + font-style: italic; + font-size: 90% +} BODY { background: white; color: black; @@ -137,11 +180,16 @@ TD.indexvalue { border: 1px solid #CCCCCC; } TR.memlist { - background-color: #f0f0f0; + background-color: #f0f0f0; +} +P.formulaDsp { + text-align: center; +} +IMG.formulaDsp { +} +IMG.formulaInl { + vertical-align: middle; } -P.formulaDsp { text-align: center; } -IMG.formulaDsp { } -IMG.formulaInl { vertical-align: middle; } SPAN.keyword { color: #008000 } SPAN.keywordtype { color: #604020 } SPAN.keywordflow { color: #e08000 } @@ -149,8 +197,13 @@ SPAN.comment { color: #800000 } SPAN.preprocessor { color: #806020 } SPAN.stringliteral { color: #002080 } SPAN.charliteral { color: #008080 } +SPAN.vhdldigit { color: #ff00ff } +SPAN.vhdlchar { color: #000000 } +SPAN.vhdlkeyword { color: #700070 } +SPAN.vhdllogic { color: #ff0000 } + .mdescLeft { - padding: 0px 8px 4px 8px; + padding: 0px 8px 4px 8px; font-size: 80%; font-style: italic; background-color: #FAFAFA; @@ -161,7 +214,7 @@ SPAN.charliteral { color: #008080 } margin: 0px; } .mdescRight { - padding: 0px 8px 4px 8px; + padding: 0px 8px 4px 8px; font-size: 80%; font-style: italic; background-color: #FAFAFA; @@ -258,23 +311,26 @@ SPAN.charliteral { color: #008080 } border-right-style: none; border-bottom-style: none; border-left-style: none; - color: #606060; + color: #606060; background-color: #FAFAFA; font-size: 80%; } -.search { color: #003399; - font-weight: bold; +.search { + color: #003399; + font-weight: bold; } FORM.search { - margin-bottom: 0px; - margin-top: 0px; + margin-bottom: 0px; + margin-top: 0px; } -INPUT.search { font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #e8eef2; +INPUT.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; } -TD.tiny { font-size: 75%; +TD.tiny { + font-size: 75%; } a { color: #1A41A8; @@ -282,66 +338,70 @@ a { a:visited { color: #2A3798; } -.dirtab { padding: 4px; - border-collapse: collapse; - border: 1px solid #84b0c7; +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; } -TH.dirtab { background: #e8eef2; - font-weight: bold; +TH.dirtab { + background: #e8eef2; + font-weight: bold; } -HR { height: 1px; - border: none; - border-top: 1px solid black; +HR { + height: 1px; + border: none; + border-top: 1px solid black; } /* Style for detailed member documentation */ .memtemplate { - font-size: 80%; - color: #606060; - font-weight: normal; + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; } .memnav { - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; } .memitem { - padding: 4px; - background-color: #eef3f5; - border-width: 1px; - border-style: solid; - border-color: #dedeee; - -moz-border-radius: 8px 8px 8px 8px; + padding: 4px; + background-color: #eef3f5; + border-width: 1px; + border-style: solid; + border-color: #dedeee; + -moz-border-radius: 8px 8px 8px 8px; } .memname { - white-space: nowrap; - font-weight: bold; + white-space: nowrap; + font-weight: bold; } .memdoc{ - padding-left: 10px; + padding-left: 10px; } .memproto { - background-color: #d5e1e8; - width: 100%; - border-width: 1px; - border-style: solid; - border-color: #84b0c7; - font-weight: bold; - -moz-border-radius: 8px 8px 8px 8px; + background-color: #d5e1e8; + width: 100%; + border-width: 1px; + border-style: solid; + border-color: #84b0c7; + font-weight: bold; + -moz-border-radius: 8px 8px 8px 8px; } .paramkey { - text-align: right; + text-align: right; } .paramtype { - white-space: nowrap; + white-space: nowrap; } .paramname { - color: #602020; - font-style: italic; - white-space: nowrap; + color: #602020; + font-style: italic; + white-space: nowrap; } /* End Styling for detailed member documentation */ @@ -350,9 +410,67 @@ HR { height: 1px; font-family: sans-serif; margin:0.5em; } -.directory { font-size: 9pt; font-weight: bold; } -.directory h3 { margin: 0px; margin-top: 1em; font-size: 11pt; } -.directory > h3 { margin-top: 0; } -.directory p { margin: 0px; white-space: nowrap; } -.directory div { display: none; margin: 0px; } -.directory img { vertical-align: -30%; } +/* these are for tree view when used as main index */ +.directory { + font-size: 9pt; + font-weight: bold; +} +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* The following two styles can be used to replace the root node title */ +/* with an image of your choice. Simply uncomment the next two styles, */ +/* specify the name of your image and be sure to set 'height' to the */ +/* proper pixel height of your image. */ + +/* .directory h3.swap { */ +/* height: 61px; */ +/* background-repeat: no-repeat; */ +/* background-image: url("yourimage.gif"); */ +/* } */ +/* .directory h3.swap span { */ +/* display: none; */ +/* } */ + +.directory > h3 { + margin-top: 0; +} +.directory p { + margin: 0px; + white-space: nowrap; +} +.directory div { + display: none; + margin: 0px; +} +.directory img { + vertical-align: -30%; +} +/* these are for tree view when not used as main index */ +.directory-alt { + font-size: 100%; + font-weight: bold; +} +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} +.directory-alt > h3 { + margin-top: 0; +} +.directory-alt p { + margin: 0px; + white-space: nowrap; +} +.directory-alt div { + display: none; + margin: 0px; +} +.directory-alt img { + vertical-align: -30%; +} + -- GitLab