Make the gil doxygen docs a litte more boost friendly and a bit to build.

* Add a shell script to make building easier. * Merge the two different versions of adobe_source.css. * `shorten_file_name.sh`: * Add copyright. * Use GNU sed and expr in shorten_file_name.sh. * Optimise it slightly by using xargs instead of a loop. * Only shorten file names in html files. * `header.html`: * Add copyright notice to doxygen header. * Remove google analytics tags. * Remove adobe RSS feed. * Remove the link to `globals.html` as it isn't generated. * Rename to `header_html.txt` to stop inspect complaining about it. * Remove `insert_boost_licence.sh` as the copyright is already in the header. [SVN r52727]
2026-01-19 04:12:11 +00:00 · 2009-05-02 12:39:02 +00:00
parent 2f61fb2dd1
commit d0b508ea80
7 changed files with 184 additions and 75 deletions
--- a/doc/adobe_source.css
+++ b/doc/adobe_source.css
@@ -133,8 +133,8 @@ A.codeRef:link, A.codeRef:visited {

 A:link, A:visited {
    text-decoration: none;
-    color: red;
-    border-bottom: 1px solid red;
+    color: #cc0000;
+    border-bottom: 1px solid #cc0000;
 }

 A:link:hover, A:visited:hover {
@@ -149,7 +149,7 @@ DL.el {

 .fragment {
 	font-family: Monaco, Courier New, Fixed, monospace;
-    font-size: 10px;
+    font-size: 12px;
 }

 PRE.fragment {
@@ -166,6 +166,8 @@ DIV.ah {
    margin-top: 3px
 }

+/* I'm not sure about the next few, but they appear in the doxygen docs but weren't in the doxygen CSS. */
+
 TD.md {
 	font-family: Monaco, Courier New, Fixed, monospace;
    background: transparent;
@@ -227,10 +229,6 @@ IMG {
    border: none;
 }

-.footerdiv {
-    background-color: #eeeeee;
-}
-
 .footerdiv, .footerdiv a, .footerdiv p, .footerdiv ul , .footerdiv ul li {
    font-size: 9px;
    color: grey;
@@ -240,6 +238,15 @@ IMG {
    margin-bottom: 3px;
 }

+.footerdiv {
+    width: 1000px;
+    margin: 0;
+    padding: 0;
+    margin-top: 30px;
+    margin-right: auto;
+    margin-left: auto;
+}
+
 .footerdiv ul {
    list-style: none;
    display: table;
@@ -259,6 +266,7 @@ SPAN.preprocessor  { color: mediumblue }
 SPAN.stringliteral { color: maroon }
 SPAN.charliteral   { color: maroon }

+/* Again, this is only in the doxygen documentation, but wasn't in the doxygen css. */
 .mdTable {
 	border: 1px solid #666666;
 	background-color: lavender;
@@ -284,6 +292,7 @@ SPAN.charliteral   { color: maroon }

 .memItemLeft {
 	font-family: Monaco, Courier New, Fixed, monospace;
+	font-size: 11px;
 	padding: 4px;
 	border: none;
 	border-top: 1px solid lightgray;
@@ -291,6 +300,7 @@ SPAN.charliteral   { color: maroon }

 .memItemRight {
 	font-family: Monaco, Courier New, Fixed, monospace;
+	font-size: 11px;
 	padding: 4px;
 	border: none;
 	border-top: 1px solid lightgray;
@@ -298,18 +308,21 @@ SPAN.charliteral   { color: maroon }

 .memTemplItemLeft {
 	font-family: Monaco, Courier New, Fixed, monospace;
+	font-size: 11px;
 	padding: 4px;
 	border: none;
 }

 .memTemplItemRight {
 	font-family: Monaco, Courier New, Fixed, monospace;
+	font-size: 11px;
 	padding: 4px;
 	border: none;
 }

 .memTemplParams {
 	font-family: Monaco, Courier New, Fixed, monospace;
+	font-size: 11px;
 	padding: 4px;
 	border: none;
 	border-top: 1px solid lightgray;
@@ -336,3 +349,85 @@ HR {
    border: none;
    border-top: 1px solid black;
 }
+
+/* Style for detailed member documentation */
+
+.memtemplate {
+	font-family: Monaco, Courier New, Fixed, monospace;
+    color: #606060;
+    font-weight: normal;
+	font-size: 11px;
+} 
+
+.memnav { 
+    background-color: #e8eef2;
+    border: 1px solid #84b0c7;
+    text-align: center;
+    margin: 2px;
+    margin-right: 15px;
+    padding: 2px;
+	font-size: 11px;
+}
+
+.memitem {
+    padding: 0;
+    padding-bottom: 15px;
+	font-size: 11px;
+}
+
+.memname {
+	font-family: Monaco, Courier New, Fixed, monospace;
+	font-size: 11px;
+    white-space: nowrap;
+}
+
+.memname td {
+    vertical-align: bottom;
+	font-size: 11px;
+}
+
+.memdoc{
+    padding-left: 10px;
+}
+
+.memproto {
+    border: 1px solid gray;
+    background-color: lavender;
+    padding: 5px;
+    -moz-border-radius: 8px 8px 8px 8px;
+}
+
+.paramkey {
+	font-family: Monaco, Courier New, Fixed, monospace;
+	font-size: 11px;
+    text-align: right;
+}
+
+.paramtype {
+	font-family: Monaco, Courier New, Fixed, monospace;
+	font-size: 11px;
+    white-space: nowrap;
+}
+
+.paramname {
+	font-family: Monaco, Courier New, Fixed, monospace;
+	font-size: 11px;
+}
+/* End Styling for detailed member documentation */
+
+/* for the tree view */
+
+.ftvtree {
+	font-family: sans-serif;
+	margin:0.5em;
+}
+
+.directory { font-size: 10px; font-weight: bold; }
+.directory h3 { margin: 0px; margin-top: 1em; font-size: 11px; }
+.directory > h3 { margin-top: 0; }
+.directory p {
+    margin: 0px;
+    white-space: nowrap;
+}
+.directory div { display: none; margin: 0px; }
+.directory img { vertical-align: -30%; }
--- a/doc/build.sh
+++ b/doc/build.sh
@@ -0,0 +1,15 @@
+#!/bin/sh -e
+
+# Copyright 2009 Daniel James.
+# Distributed under the Boost Software License, Version 1.0. (See accompanying
+# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+rm -r html
+
+cd doxygen/gil_standalone/
+doxygen gil_boost.doxygen
+cd -
+
+cd html
+../shorten_file_name.sh
+cd -
--- a/doc/doxygen/gil_standalone/gil_boost.doxygen
+++ b/doc/doxygen/gil_standalone/gil_boost.doxygen
@@ -145,7 +145,7 @@ IGNORE_PREFIX          =
 GENERATE_HTML          = YES
 HTML_OUTPUT            = html
 HTML_FILE_EXTENSION    = .html
-HTML_HEADER            = header.html
+HTML_HEADER            = header_html.txt
 HTML_FOOTER            = 
 HTML_STYLESHEET        = ../../adobe_source.css
 HTML_ALIGN_MEMBERS     = YES
--- a/doc/doxygen/gil_standalone/header_html.txt
+++ b/doc/doxygen/gil_standalone/header_html.txt
@@ -1,3 +1,10 @@
+<!-- Copyright 2008 Lubomir Bourdev and Hailin Jin
+
+     Distributed under the Boost Software License, Version 1.0.
+     (See accompanying file LICENSE_1_0.txt or copy at
+     http://www.boost.org/LICENSE_1_0.txt)
+  -->
+
 <!--
    Copyright 2005-2007 Adobe Systems Incorporated
    Distributed under the MIT License (see accompanying file LICENSE_1_0_0.txt
@@ -15,9 +22,6 @@
    <TITLE>$title</TITLE>
    <META HTTP-EQUIV="content-type" CONTENT="text/html;charset=ISO-8859-1"/>
    <LINK TYPE="text/css" REL="stylesheet" HREF="adobe_source.css"/>
-    <LINK REL="alternate" TITLE="stlab.adobe.com RSS" HREF="http://sourceforge.net/export/rss2_projnews.php?group_id=132417&amp;rss_fulltext=1" TYPE="application/rss+xml"/>
-    <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
-    </script>
 </head>
 <body>
 <table border="0" cellspacing="0" cellpadding="0" style='width: 100%; margin: 0; padding: 0'><tr>
@@ -27,7 +31,6 @@
                  | <a class="qindex" href="annotated.html">Class List</a> 
                  | <a class="qindex" href="dirs.html">Directories</a> 
                  | <a class="qindex" href="files.html">File List</a> 
-                  | <a class="qindex" href="globals.html">File Members</a> 
                  | <a class="qindex" href="../index.html">GIL Home Page</a> 
 </div>
 <!-- End Header -->
--- a/doc/html/adobe_source.css
+++ b/doc/html/adobe_source.css
@@ -20,17 +20,10 @@ BODY,TD {
    font-size: 12px;
    margin: 0;
    padding: 0;
-	background: transparent;
+	background: white;
 	color: black;
 }

-#content {
-    padding-top: 20px;
-    width: 1000px;
-    margin-right: auto;
-    margin-left: auto;
-}
-
 TABLE {
    margin: 0;
    padding: 0;
@@ -44,13 +37,13 @@ H1 {

 H2 {
    font-size: 16px;
-    #border-top: 1px dotted #666666;
+    border-top: 1px dotted #666666;
    border-bottom: 1px dotted #666666;
 }

 H3 {
    font-size: 14px;
-    #border-top: 1px dotted #666666;
+    border-top: 1px dotted #666666;
    border-bottom: 1px dotted #666666;
 }

@@ -58,38 +51,6 @@ CAPTION {
    font-weight: bold
 }

-#maintable {
-    padding: 10px;
-    padding-top: 0px;
-    #border: 1px solid grey;
-    background-color: white;
-}
-
-#navtable {
-    padding-top: 3px;
-    padding-left: 3px;
-    background: url('navbkg.png');
-    background-repeat: no-repeat;
-    background-color: white;
-    width: 150px;
-}
-
-#navtable h4 {
-    text-align: center;
-    border: none;
-}
-
-#navtable a {
-    font-size: 11px;
-}
-
-#opensource_banner {
-    width: 1000px;
-    background-color: white;
-    #border: 1px solid grey;
-    margin-bottom: 20px;
-}
-
 DIV.qindex {
 	width: 100%;
 	background-color: #e8eef2;
@@ -176,6 +137,12 @@ A:link, A:visited {
    border-bottom: 1px solid #cc0000;
 }

+A:link:hover, A:visited:hover {
+    text-decoration: none;
+    color: darkred;
+    border-bottom: 1px solid darkred;
+}
+
 DL.el {
    margin-left: -1cm
 }
@@ -194,11 +161,36 @@ PRE.fragment {

 DIV.ah {
    background-color: black;
-    color: transparent;
+    color: white;
    margin-bottom: 3px;
    margin-top: 3px
 }

+/* I'm not sure about the next few, but they appear in the doxygen docs but weren't in the doxygen CSS. */
+
+TD.md {
+	font-family: Monaco, Courier New, Fixed, monospace;
+    background: transparent;
+}
+
+TD.mdPrefix {
+	font-family: Monaco, Courier New, Fixed, monospace;
+    color: #555555;
+    font-size: 12px;
+    background: transparent;
+}
+
+TD.mdname1 {
+    color: darkred;
+    background: transparent;
+}
+
+TD.mdname {
+    color: darkred;
+    white-space: nowrap;
+    background: transparent;
+}
+
 DIV.groupHeader {
    margin-left: 16px;
    margin-top: 12px;
@@ -274,6 +266,18 @@ SPAN.preprocessor  { color: mediumblue }
 SPAN.stringliteral { color: maroon }
 SPAN.charliteral   { color: maroon }

+/* Again, this is only in the doxygen documentation, but wasn't in the doxygen css. */
+.mdTable {
+	border: 1px solid #666666;
+	background-color: lavender;
+    padding: 10px;
+    width: 100%;
+}
+
+.mdRow {
+    background: lavender;
+}
+
 .mdescLeft {
 	font-style: italic;
 	border: none;
--- a/doc/insert_boost_licence.sh
+++ b/doc/insert_boost_licence.sh
@@ -1,12 +0,0 @@
-#!/bin/sh
-ii=`expr $#`
-for file in $@
-  do
-  if [ $ii -lt $# ]
-      then
-      echo Processing $file ...
-      cat $1 $file > tmp
-      mv tmp $file
-  fi
-  ii=`expr $ii - 1`
-done
--- a/doc/shorten_file_name.sh
+++ b/doc/shorten_file_name.sh
@@ -1,4 +1,11 @@
-#!/bin/sh
+#!/bin/sh -e
+
+# Copyright 2008 Lubomir Bourdev and Hailin Jin
+#
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
 if [ $# -lt 1 ]
    then
    $0 html
@@ -13,17 +20,14 @@ for file_extension in $@
  kk=0
  for long_file_name in *.$1
    do
-    file_name_length=`expr length $long_file_name`
+    file_name_length=`gexpr length $long_file_name`
    if [ $file_name_length -gt 20 ]
        then
-        kk=`expr $kk + 1`
+        kk=`gexpr $kk + 1`
        short_file_name=`printf "g_i_l_%04d.$1" $kk`
        echo \ \ Shortening $long_file_name to $short_file_name ...
-        for ii in `grep -l $long_file_name *`
-          do
-          sed_string="s/\\\"$long_file_name/\\\"$short_file_name/g"
-          sed -i $sed_string $ii
-        done
+        sed_string="s/\\\"$long_file_name/\\\"$short_file_name/g"
+        grep -l $long_file_name *.htm* | xargs gsed -i $sed_string
        mv $long_file_name $short_file_name
    fi
  done