Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r52727 - in trunk/libs/gil/doc: . doxygen/gil_standalone html
From: daniel_james_at_[hidden]
Date: 2009-05-02 08:39:05

Next message: daniel_james_at_[hidden]: "[Boost-commit] svn:boost r52728 - trunk/libs/gil/doc/html"
Previous message: daniel_james_at_[hidden]: "[Boost-commit] svn:boost r52726 - in trunk/libs/gil/doc/doxygen: . gil_standalone images"

Author: danieljames
Date: 2009-05-02 08:39:02 EDT (Sat, 02 May 2009)
New Revision: 52727
URL: http://svn.boost.org/trac/boost/changeset/52727

Log:
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.
Added:
   trunk/libs/gil/doc/build.sh (contents, props changed)
   trunk/libs/gil/doc/doxygen/gil_standalone/header_html.txt (contents, props changed)
      - copied, changed from r52726, /trunk/libs/gil/doc/doxygen/gil_standalone/header.html
Removed:
   trunk/libs/gil/doc/doxygen/gil_standalone/header.html
   trunk/libs/gil/doc/insert_boost_licence.sh
Text files modified:
   trunk/libs/gil/doc/adobe_source.css | 109 +++++++++++++++++++++++++++++++++++++--
   trunk/libs/gil/doc/doxygen/gil_standalone/gil_boost.doxygen | 3
   trunk/libs/gil/doc/doxygen/gil_standalone/header_html.txt | 11 ++-
   trunk/libs/gil/doc/html/adobe_source.css | 90 +++++++++++++++++---------------
   trunk/libs/gil/doc/shorten_file_name.sh | 20 ++++--
   5 files changed, 169 insertions(+), 64 deletions(-)

Modified: trunk/libs/gil/doc/adobe_source.css
==============================================================================
--- trunk/libs/gil/doc/adobe_source.css (original)
+++ trunk/libs/gil/doc/adobe_source.css 2009-05-02 08:39:02 EDT (Sat, 02 May 2009)
@@ -133,8 +133,8 @@

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 @@

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

PRE.fragment {
@@ -166,6 +166,8 @@
     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 @@
     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 @@
     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.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 @@

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

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

.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 @@
     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%; }

Added: trunk/libs/gil/doc/build.sh
==============================================================================
--- (empty file)
+++ trunk/libs/gil/doc/build.sh 2009-05-02 08:39:02 EDT (Sat, 02 May 2009)
@@ -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 -
\ No newline at end of file

Modified: trunk/libs/gil/doc/doxygen/gil_standalone/gil_boost.doxygen
==============================================================================
--- trunk/libs/gil/doc/doxygen/gil_standalone/gil_boost.doxygen (original)
+++ trunk/libs/gil/doc/doxygen/gil_standalone/gil_boost.doxygen 2009-05-02 08:39:02 EDT (Sat, 02 May 2009)
@@ -145,7 +145,7 @@
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

Deleted: trunk/libs/gil/doc/doxygen/gil_standalone/header.html
==============================================================================
--- trunk/libs/gil/doc/doxygen/gil_standalone/header.html 2009-05-02 08:39:02 EDT (Sat, 02 May 2009)
+++ (empty file)
@@ -1,33 +0,0 @@
-
-
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
-
-<head>
- <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&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>
-<td width="100%" valign="top" style='padding-left: 10px; padding-right: 10px; padding-bottom: 10px'>
-<div class="qindex"><a class="qindex" href="index.html">Modules</a>
- | <a class="qindex" href="classes.html">Alphabetical List</a>
- | <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>
-

Copied: trunk/libs/gil/doc/doxygen/gil_standalone/header_html.txt (from r52726, /trunk/libs/gil/doc/doxygen/gil_standalone/header.html)
==============================================================================
--- /trunk/libs/gil/doc/doxygen/gil_standalone/header.html (original)
+++ trunk/libs/gil/doc/doxygen/gil_standalone/header_html.txt 2009-05-02 08:39:02 EDT (Sat, 02 May 2009)
@@ -1,3 +1,10 @@
+
+

Modified: trunk/libs/gil/doc/html/adobe_source.css
==============================================================================
--- trunk/libs/gil/doc/html/adobe_source.css (original)
+++ trunk/libs/gil/doc/html/adobe_source.css 2009-05-02 08:39:02 EDT (Sat, 02 May 2009)
@@ -20,17 +20,10 @@
     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 @@

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 @@
     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 @@
     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 @@

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.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;

Deleted: trunk/libs/gil/doc/insert_boost_licence.sh
==============================================================================
--- trunk/libs/gil/doc/insert_boost_licence.sh 2009-05-02 08:39:02 EDT (Sat, 02 May 2009)
+++ (empty file)
@@ -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

Modified: trunk/libs/gil/doc/shorten_file_name.sh
==============================================================================
--- trunk/libs/gil/doc/shorten_file_name.sh (original)
+++ trunk/libs/gil/doc/shorten_file_name.sh 2009-05-02 08:39:02 EDT (Sat, 02 May 2009)
@@ -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 @@
   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

Next message: daniel_james_at_[hidden]: "[Boost-commit] svn:boost r52728 - trunk/libs/gil/doc/html"
Previous message: daniel_james_at_[hidden]: "[Boost-commit] svn:boost r52726 - in trunk/libs/gil/doc/doxygen: . gil_standalone images"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk