[mm-common] Add doxygen-extra.css, deprecate doxygen.css



commit af49892cd793130d049f5ae5ede9cdd6eefa1113
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date:   Tue Aug 26 09:35:02 2014 +0200

    Add doxygen-extra.css, deprecate doxygen.css
    
    * README: Say that doxygen.css is deprecated. Add description of
    doxygen-extra.css.
    * Makefile.am: Distribute doxygen-extra.css.
    * build/doc-reference.am: Distribute doxygen-extra.css.
    * skeletonmm/.gitignore: Ignore doxygen-extra.css.
    * skeletonmm/doc/reference/Doxyfile.in: Use doxygen-extra.css instead
    of doxygen.css.
    * util/doxygen.css: Add comment, saying it's deprecated.
    * util/doxygen-extra.css: New file. Equal to doxygen.css except for comments.
    * util/mm-common-prepare.in: Copy doxygen-extra.css.
    * util/mm-common-prepare.1.in: List doxygen-extra.css.
    https://mail.gnome.org/archives/gtkmm-list/2014-August/msg00022.html

 Makefile.am                          |    1 +
 README                               |    5 +
 build/doc-reference.am               |    2 +-
 skeletonmm/.gitignore                |    1 +
 skeletonmm/doc/reference/Doxyfile.in |    4 +-
 util/doxygen-extra.css               |  263 ++++++++++++++++++++++++++++++++++
 util/doxygen.css                     |    8 +
 util/mm-common-prepare.1.in          |    4 +-
 util/mm-common-prepare.in            |    2 +-
 9 files changed, 285 insertions(+), 5 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index bea7168..8db5e8b 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -48,6 +48,7 @@ dist_doctool_DATA =                   \
        util/doc-install.pl             \
        util/doc-postprocess.pl         \
        util/doxygen.css                \
+       util/doxygen-extra.css          \
        util/tagfile-to-devhelp2.xsl
 
 doctagsdir = $(pkgdatadir)/doctags
diff --git a/README b/README
index 928f688..aa5db10 100644
--- a/README
+++ b/README
@@ -178,6 +178,11 @@ util/doc-install.pl:
 util/doxygen.css:
   A Cascading Style Sheet to unify the appearance of the HTML reference
   documentation generated by Doxygen for each C++ binding module.
+  This file is deprecated. Use util/doxygen-extra.css instead.
+
+util/doxygen-extra.css:
+  A Cascading Style Sheet to unify the appearance of the HTML reference
+  documentation generated by Doxygen for each C++ binding module.
 
 util/tagfile-to-devhelp2.xsl:
   An XSLT script to generate a Devhelp2 book for the Doxygen reference
diff --git a/build/doc-reference.am b/build/doc-reference.am
index cb77754..975d23f 100644
--- a/build/doc-reference.am
+++ b/build/doc-reference.am
@@ -78,7 +78,7 @@ doc_dist_files   =
 endif
 
 if DIST_DOCTOOLS
-doc_dist_files   += $(MMDOCTOOLDIR)/doc-postprocess.pl $(MMDOCTOOLDIR)/doc-install.pl 
$(MMDOCTOOLDIR)/tagfile-to-devhelp2.xsl $(MMDOCTOOLDIR)/doxygen.css
+doc_dist_files += $(MMDOCTOOLDIR)/doc-postprocess.pl $(MMDOCTOOLDIR)/doc-install.pl 
$(MMDOCTOOLDIR)/tagfile-to-devhelp2.xsl $(MMDOCTOOLDIR)/doxygen.css $(MMDOCTOOLDIR)/doxygen-extra.css
 endif
 
 dist_reference_DATA = $(strip $(doc_inst_files))
diff --git a/skeletonmm/.gitignore b/skeletonmm/.gitignore
index 18bbe0b..22d053d 100644
--- a/skeletonmm/.gitignore
+++ b/skeletonmm/.gitignore
@@ -26,5 +26,6 @@ stamp-h?
 /doc/doc-install.pl
 /doc/doc-postprocess.pl
 /doc/doxygen.css
+/doc/doxygen-extra.css
 /doc/tagfile-to-devhelp2.xsl
 
diff --git a/skeletonmm/doc/reference/Doxyfile.in b/skeletonmm/doc/reference/Doxyfile.in
index af36b3a..9c15ac9 100644
--- a/skeletonmm/doc/reference/Doxyfile.in
+++ b/skeletonmm/doc/reference/Doxyfile.in
@@ -156,8 +156,8 @@ HTML_OUTPUT            = html
 HTML_FILE_EXTENSION    = .html
 HTML_HEADER            =
 HTML_FOOTER            =
-HTML_STYLESHEET        = "$(MMDOCTOOLDIR)/doxygen.css"
-HTML_EXTRA_STYLESHEET  =
+HTML_STYLESHEET        =
+HTML_EXTRA_STYLESHEET  = "$(MMDOCTOOLDIR)/doxygen-extra.css"
 HTML_EXTRA_FILES       =
 HTML_COLORSTYLE_HUE    = 220
 HTML_COLORSTYLE_SAT    = 100
diff --git a/util/doxygen-extra.css b/util/doxygen-extra.css
new file mode 100644
index 0000000..6691e37
--- /dev/null
+++ b/util/doxygen-extra.css
@@ -0,0 +1,263 @@
+/* GNOME C++ bindings Doxygen style */
+
+/* Use in Doxyfile.in
+ *   HTML_EXTRA_STYLESHEET = "$(MMDOCTOOLDIR)/doxygen-extra.css"
+ */
+
+html, body {
+  background: #FFFFFF;
+  color: #222222;
+  margin: 0;
+}
+
+body {
+  font: normal 90%/150% sans-serif;
+  padding: 1.5em;
+  min-width: 28em;
+}
+
+table {
+  font-size: inherit;
+}
+
+img {
+  border-style: none;
+}
+
+address img {
+  vertical-align: middle;
+}
+
+h1 {
+  font-size: 150%;
+  line-height: 120%;
+  text-align: center;
+}
+
+h2 {
+  font-size: 120%;
+}
+
+h3 {
+  font-size: 100%;
+}
+
+h1 + h3 {
+  text-align: center;
+}
+
+.navpath {
+  display: none;
+}
+
+caption {
+  font-weight: bold;
+}
+
+p, dl {
+  margin: 0.75em 0;
+}
+
+.center {
+  text-align: center;
+}
+
+div.qindex {
+  width: 100%;
+  line-height: 140%;
+  background-color: #E8EEF2;
+  border: 1px solid #84B0C7;
+  text-align: center;
+  margin: 0.2em;
+  padding: 0.2em;
+}
+
+a {
+  color: #153788;
+  font-weight: normal;
+  text-decoration: none;
+}
+
+.contents a:visited {
+  color: #1B77C5;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+a.el, a.qindex {
+  font-weight: bold;
+}
+
+dl.el {
+  margin-left: -1.5em;
+}
+
+code, .fragment {
+  font-family: monospace, fixed;
+}
+
+pre.fragment, div.fragment {
+  background-color: #EEEEFF;
+  border: 1px solid #AAAAFF;
+  padding: 0.5em;
+  margin: 0.375em 0.75em 0.375em 0.2em;
+}
+
+div.fragment > pre.fragment {
+  border-style: none;
+  padding: 0;
+  margin: 0;
+}
+
+div.line {
+  white-space: pre;
+}
+
+div.ah {
+  background-color: #000000;
+  color: #FFFFFF;
+  font-weight: bold;
+  margin: 0.2em 0;
+}
+
+.indexkey, .indexvalue {
+  background-color: #E8EEF2;
+  border: 1px solid #CCCCCC;
+  margin: 0.2em 0;
+  padding: 0.2em 0.75em;
+}
+
+.indexkey {
+  font-weight: bold;
+}
+.memlist {
+  background-color: #F0F0F0;
+}
+
+span.keyword {
+  color: #008000;
+}
+
+span.keywordtype {
+  color: #604020;
+}
+
+span.keywordflow {
+  color: #E08000;
+}
+
+span.comment {
+  color: #800000;
+}
+
+span.preprocessor {
+  color: #806020;
+}
+
+span.stringliteral {
+  color: #002080;
+}
+
+span.charliteral {
+  color: #008080;
+}
+
+.tiny {
+  font-size: 80%;
+}
+
+hr {
+  height: 0;
+  border: none;
+  border-top: 1px solid #666666;
+}
+
+.mdescLeft, .mdescRight, .memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+  background-color: #FAFAFA;
+  border: none;
+  margin: 0.375em;
+  padding: 0.125em 0 0 0.75em;
+}
+
+.mdescLeft, .mdescRight {
+  padding: 0 0.75em 0.375em;
+  color: #555555;
+}
+
+.memItemLeft, .memItemRight, .memTemplParams {
+  border-top: 1px solid #CCCCCC;
+}
+
+.memTemplParams {
+  color: #606060;
+}
+
+.memtemplate {
+  color: #606060;
+  font-size: 90%;
+  font-weight: normal;
+  margin-left: 0.2em;
+}
+
+.memnav {
+  background-color: #E8EEF2;
+  border: 1px solid #84B0C7;
+  text-align: center;
+  margin: 0.2em 1em 0.2em 0;
+  padding: 0.2em;
+}
+
+.memitem {
+  margin: 0.5em 0;
+  padding: 0;
+}
+
+.memname {
+  white-space: nowrap;
+  font-weight: bold;
+  line-height: 120%;
+}
+
+.memproto, .memdoc {
+  border: 1px solid #84B0C7;
+}
+
+.memproto {
+  padding: 0;
+  background-color: #D5E1E8;
+  font-weight: bold;
+  -webkit-border-top-left-radius: 1ex;
+  -webkit-border-top-right-radius: 1ex;
+  -moz-border-radius-topleft: 1ex;
+  -moz-border-radius-topright: 1ex;
+}
+
+.memdoc {
+  padding: 0.2em 0.5em;
+  background-color: #EEF3F5;
+  border-top-width: 0;
+  -webkit-border-bottom-left-radius: 1ex;
+  -webkit-border-bottom-right-radius: 1ex;
+  -moz-border-radius-bottomleft: 1ex;
+  -moz-border-radius-bottomright: 1ex;
+}
+
+.paramkey {
+  text-align: right;
+}
+
+.paramtype {
+  white-space: nowrap;
+}
+
+.paramname {
+  color: #602020;
+  white-space: nowrap;
+}
+
+.paramname em {
+  font-style: normal;
+}
diff --git a/util/doxygen.css b/util/doxygen.css
index 80d987e..637ee61 100644
--- a/util/doxygen.css
+++ b/util/doxygen.css
@@ -1,5 +1,13 @@
 /* GNOME C++ bindings Doxygen style */
 
+/* This file is deprecated.
+ * In Doxyfile.in you should use
+ *   HTML_EXTRA_STYLESHEET = "$(MMDOCTOOLDIR)/doxygen-extra.css"
+ * instead of
+ *   HTML_STYLESHEET = "$(MMDOCTOOLDIR)/doxygen.css"
+ * See https://mail.gnome.org/archives/gtkmm-list/2014-August/msg00022.html
+ */
+
 html, body {
   background: #FFFFFF;
   color: #222222;
diff --git a/util/mm-common-prepare.1.in b/util/mm-common-prepare.1.in
index 752d865..7658031 100644
--- a/util/mm-common-prepare.1.in
+++ b/util/mm-common-prepare.1.in
@@ -1,4 +1,4 @@
-.TH MM-COMMON-PREPARE 1 2009-12-29 GNOME "@PACKAGE_STRING@"
+.TH MM-COMMON-PREPARE 1 2014-08-13 GNOME "@PACKAGE_STRING@"
 .SH NAME
 mm-common-prepare \- Prepare a C++ binding module to use mm-common
 .SH SYNOPSIS
@@ -88,6 +88,8 @@ are listed below.
 .IP
 .I doxygen.css
 .IP
+.I doxygen-extra.css
+.IP
 .I tagfile-to-devhelp2.xsl
 .PD
 .SH "SEE ALSO"
diff --git a/util/mm-common-prepare.in b/util/mm-common-prepare.in
index d3ea47f..5285095 100644
--- a/util/mm-common-prepare.in
+++ b/util/mm-common-prepare.in
@@ -106,7 +106,7 @@ then
   echo "$progname: putting documentation utilities in '$doctooldir'."
   test -d "$doctooldir" || mkdir "$doctooldir"
 
-  for file in doc-install.pl doc-postprocess.pl doxygen.css tagfile-to-devhelp2.xsl
+  for file in doc-install.pl doc-postprocess.pl doxygen.css doxygen-extra.css tagfile-to-devhelp2.xsl
   do
     if test -n "$forceflag" || test ! -f "$doctooldir/$file"; then
       echo "$progname: $instaction file '$file'"


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]