diff options
author | Jonathon Jongsma <jjongsma@gnome.org> | 2006-05-09 03:12:42 +0000 |
---|---|---|
committer | Jonathon Jongsma <jjongsma@gnome.org> | 2006-05-09 03:12:42 +0000 |
commit | 5eed66307338f5ee7ae63c02986f49e5e10819af (patch) | |
tree | 599d1335cb1d90f94de3c8be2f3927e88f9a9052 | |
parent | 2e6b32ec83cfbabee8b453ab7bc52aaac73bd3fc (diff) |
2006-05-08 Jonathon Jongsma <jonathon.jongsma@gmail.com>
* cairomm/cairomm.h: Add doxygen API introduction test here.
* docs/reference/Doxyfile.in:
* docs/reference/Makefile.am:
* docs/reference/cairomm-header.html:
* docs/reference/cairomm.css:
* docs/reference/introduction.h: fix up some documentation presentation
issues that turned up with newer versions of doxygen.
-rw-r--r-- | ChangeLog | 10 | ||||
-rw-r--r-- | cairomm/cairomm.h | 12 | ||||
-rw-r--r-- | docs/reference/Doxyfile.in | 4 | ||||
-rw-r--r-- | docs/reference/Makefile.am | 5 | ||||
-rw-r--r-- | docs/reference/cairomm-header.html | 8 | ||||
-rw-r--r-- | docs/reference/cairomm.css | 31 | ||||
-rw-r--r-- | docs/reference/introduction.h | 11 |
7 files changed, 56 insertions, 25 deletions
@@ -1,5 +1,15 @@ 2006-05-08 Jonathon Jongsma <jonathon.jongsma@gmail.com> + * cairomm/cairomm.h: Add doxygen API introduction test here. + * docs/reference/Doxyfile.in: + * docs/reference/Makefile.am: + * docs/reference/cairomm-header.html: + * docs/reference/cairomm.css: + * docs/reference/introduction.h: fix up some documentation presentation + issues that turned up with newer versions of doxygen. + +2006-05-08 Jonathon Jongsma <jonathon.jongsma@gmail.com> + * configure.in: remove check for perl since we're not using any of the gmmproc stuff for cairomm * docs/reference/Makefile.am: add documentation dependency on all of the diff --git a/cairomm/cairomm.h b/cairomm/cairomm.h index 567f45d..c838df0 100644 --- a/cairomm/cairomm.h +++ b/cairomm/cairomm.h @@ -19,6 +19,18 @@ #ifndef __CAIROMM_H #define __CAIROMM_H +/** \mainpage Cairomm: A C++ wrapper for the cairo graphics library + * + * \section License + * Cairomm is available under the terms of the LGPL license + * + * \section Introduction + * If you're just beginning to learn cairomm, a good place to start is with the + * Cairo::Surface and Cairo::Context classes. In general terms, you draw onto + * a Surface using the graphics settings specified in your Context. + * + */ + #include <cairomm/context.h> #include <cairomm/surface.h> #include <cairomm/fontoptions.h> diff --git a/docs/reference/Doxyfile.in b/docs/reference/Doxyfile.in index 1d74bd0..8abb1d3 100644 --- a/docs/reference/Doxyfile.in +++ b/docs/reference/Doxyfile.in @@ -71,7 +71,7 @@ WARN_LOGFILE = undocumented.txt #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = @top_srcdir@/cairomm @srcdir@/introduction.h +INPUT = @top_srcdir@/cairomm FILE_PATTERNS = *.h RECURSIVE = NO EXCLUDE = @top_srcdir@/cairomm/private.h @@ -106,7 +106,7 @@ IGNORE_PREFIX = GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -HTML_HEADER = +HTML_HEADER = cairomm-header.html HTML_FOOTER = HTML_STYLESHEET = cairomm.css HTML_ALIGN_MEMBERS = YES diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 934740a..416df77 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -2,14 +2,15 @@ DOXYGEN_CONFIGFILE = Doxyfile DOXYGEN_CONFIGFILE_SOURCE = Doxyfile.in WEB_SERVER = cairographics.org WEB_SERVER_PATH = /srv/cairo.freedesktop.org/www/documentation/cairomm/reference +HTML_TEMPLATE_FILES = cairomm.css cairomm-header.html EXTRA_DIST = $(DOXYGEN_CONFIGFILE_SOURCE) \ - introduction.h cairomm_doxygen_tags \ + introduction.h $(HTML_TEMPLATE_FILES) cairomm_doxygen_tags \ html index_html = html/index.html -$(index_html): $(DOXYGEN_CONFIGFILE) $(wildcard $(top_srcdir)/cairomm/*.h) +$(index_html): $(DOXYGEN_CONFIGFILE) $(wildcard $(top_srcdir)/cairomm/*.h) $(HTML_TEMPLATE_FILES) -rm -rf html doxygen $(DOXYGEN_CONFIGFILE) \ 2> doxygen-warnings.txt | tee doxygen-output.txt && cat doxygen-warnings.txt diff --git a/docs/reference/cairomm-header.html b/docs/reference/cairomm-header.html new file mode 100644 index 0000000..e529356 --- /dev/null +++ b/docs/reference/cairomm-header.html @@ -0,0 +1,8 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> + <title>$title</title> + <link href="cairomm.css" rel="stylesheet" type="text/css"> + </head> +<body> diff --git a/docs/reference/cairomm.css b/docs/reference/cairomm.css index 5fa1b3e..ba067e6 100644 --- a/docs/reference/cairomm.css +++ b/docs/reference/cairomm.css @@ -15,6 +15,7 @@ a:hover { h1 { text-align: center; font-size: 160%; + margin-top: 1.5em; } h2 { font-size: 140%; @@ -33,30 +34,40 @@ div.qindex { padding: 0.5em; line-height: 150%; } -DIV.nav { +div.nav { width: 100%; color: #FFFFFF; background-color: #3B80AE; text-align: center; - margin: 0.5em; padding: 0.5em; - line-height: 140%; } div.nav a:link, div.nav a:visited { color: #FFFFFF !important; text-decoration: underline; } -div.navtab { +div.tabs { background-color: #dedede; - border: 1px solid #b0b0b0; text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; + padding: 0.2em; + margin: 1em 0em; + font-size: 80%; + font-weight: bold; + width: 100%; +} +.tabs ul { + margin: 0em; + padding: 0em; + list-style: none; + text-align: center; +} +.tabs ul li { + display: inline; + padding: 0.5em 2em; } -td.navtab { - font-size: 70%; +.tabs ul li#current { + background-color: #ffffff; + border: 1px solid #cccccc; } a.qindex { font-weight: bold; diff --git a/docs/reference/introduction.h b/docs/reference/introduction.h deleted file mode 100644 index 17315bc..0000000 --- a/docs/reference/introduction.h +++ /dev/null @@ -1,11 +0,0 @@ -/** \mainpage Cairomm: A C++ wrapper for the cairo graphics library - * - * \section License - * Cairomm is available under the terms of the LGPL license - * - * \section Introduction - * If you're just beginning to learn cairomm, a good place to start is with the - * Cairo::Surface and Cairo::Context classes. In general terms, you draw onto - * a Surface using the graphics settings specified in your Context. - * - */ |