diff options
| author | Martin Schulze <MHL.Schulze@t-online.de> | 2003-04-06 13:08:46 +0000 |
|---|---|---|
| committer | Martin Schulze <teebaum@src.gnome.org> | 2003-04-06 13:08:46 +0000 |
| commit | bb6e94635362ce3d7193763b172752d190d267a4 (patch) | |
| tree | 18bdb81a6de3bb30f484c6e35ce615f9240d07dd /docs | |
| parent | 8aa4e146ac26654300fa9ca39ef731bf384825cd (diff) | |
| download | sigc++-bb6e94635362ce3d7193763b172752d190d267a4.tar.gz | |
Add Doxygen framework.
2003-04-06 Martin Schulze <MHL.Schulze@t-online.de>
* TODO, configure.ac, Makefile.am, docs/*:
Add Doxygen framework.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 36 | ||||
| -rw-r--r-- | docs/Makefile_web.am_fragment | 7 | ||||
| -rw-r--r-- | docs/images/Makefile.am | 16 | ||||
| -rw-r--r-- | docs/images/libsigc_logo.gif | bin | 0 -> 9136 bytes | |||
| -rw-r--r-- | docs/images/top.gif | bin | 0 -> 260 bytes | |||
| -rw-r--r-- | docs/index.html | 117 | ||||
| -rw-r--r-- | docs/reference/Doxyfile.in | 183 | ||||
| -rw-r--r-- | docs/reference/Makefile.am | 62 | ||||
| -rw-r--r-- | docs/reference/README | 6 | ||||
| -rwxr-xr-x | docs/reference/beautify_docs.pl | 78 | ||||
| -rw-r--r-- | docs/reference/libsigc_footer.html_fragment | 5 | ||||
| -rw-r--r-- | docs/reference/libsigc_header.html_fragment | 22 |
12 files changed, 532 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..bb64101 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,36 @@ +## Stolen from: + +## Copyright (c) 2001 +## The gtkmm development team. + +SUBDIRS = images reference # FAQ images tutorial reference internal + +EXTRA_DIST = Makefile_web.am_fragment index.html + +libsigc_doc_DATA = index.html + +include $(top_srcdir)/docs/Makefile_web.am_fragment + +# Post to the website. + +post-html-recursive: + list='$(SUBDIRS)'; for subdir in $$list; do \ + test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) post-html); \ + done + +post-html-local: index.html + scp $$SSH_OPT $^ $$USER@shell.sourceforge.net:$(web_path_docs) + +post-html: post-html-recursive post-html-local + +doc-clean-recursive: + list='$(SUBDIRS)'; for subdir in $$list; do \ + test "$$subdir" = . || (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) doc-clean); \ + done + +doc-clean: doc-clean-recursive + +doc-rebuild: doc-clean all + +.PHONY: post-html post-html-recursive doc-clean doc-clean-recursive doc-rebuild + diff --git a/docs/Makefile_web.am_fragment b/docs/Makefile_web.am_fragment new file mode 100644 index 0000000..6133411 --- /dev/null +++ b/docs/Makefile_web.am_fragment @@ -0,0 +1,7 @@ + +web_path_libsigc2 = /home/groups/l/li/libsigc/htdocs/libsigc2/ +web_path_docs = $(web_path_libsigc2)docs/ +rsync_args = -vz --rsh ssh --delete --delete-after + +libsigc_docdir = $(datadir)/doc/libsigc-2.0/docs + diff --git a/docs/images/Makefile.am b/docs/images/Makefile.am new file mode 100644 index 0000000..562c82c --- /dev/null +++ b/docs/images/Makefile.am @@ -0,0 +1,16 @@ + +EXTRA_DIST = libsigc_logo.gif top.gif + +# Post to the website. +include $(top_srcdir)/docs/Makefile_web.am_fragment + +imagesdir = $(libsigc_docdir)/images +images_DATA = libsigc_logo.gif top.gif + +post-html: libsigc_logo.gif top.gif + rsync $(rsync_args) $^ $$USER@shell.sourceforge.net:$(web_path_docs)images/ + +doc-clean: + +.PHONY: post-html doc-clean + diff --git a/docs/images/libsigc_logo.gif b/docs/images/libsigc_logo.gif Binary files differnew file mode 100644 index 0000000..6a8a36c --- /dev/null +++ b/docs/images/libsigc_logo.gif diff --git a/docs/images/top.gif b/docs/images/top.gif Binary files differnew file mode 100644 index 0000000..85d395c --- /dev/null +++ b/docs/images/top.gif diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..29b1c95 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,117 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <title>libsigc Documentation</title> + <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> + <link href="reference/html/doxygen.css" rel="stylesheet" type="text/css"> + <style type="text/css"> + body { + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: 15px; + } + </style> + </head> + <body bgcolor="#F0F0F0"> + + <div align="Center"> + <a class="qindex" href="index.html">Main Page</a> + <a class="qindex" href="reference/html/namespaces.html">Namespaces</a> + + <hr> + <h1>libsigc documentation</h1> + + <table cellspacing="1" cellpadding="2" width="100%" border="0"> + <tbody> + <tr> + <th width="33%" bgcolor="#bd2c4a" style="border: 1px solid black; color: white">General</th> + </tr> + <tr> + <td height="75"> + <table cellspacing="1" cellpadding="2" width="100%" bgcolor="white" + border="0" style="border: 1px solid black"> + <tbody> + <tr> + <th width="33%" bgcolor="#f0f0f0" align="center">Basics</th> + <th width="33%" bgcolor="#f0f0f0" align="center">What's New</th> + </tr> + <tr> + <td valign="Top" height="75"> + <ul> + <li><a href="http://libsigc.sourceforge.net">About libsigc</a></li> + <li><a href="http://libsigc.sourceforge.net/stable.shtml">Download</a></li> + <li><a href="http://libsigc.sourceforge.net/libsigc2/libsigc-docs.tar.gz">Offline documentation</a></li> + </ul> + </td> + <td valign="Top" height="75"> + <ul> + <li><a href="http://cvs.gnome.org/lxr/source/libsigc++2/NEWS">News</a></li> + <li><a href="http://cvs.gnome.org/lxr/source/libsigc++2/ChangeLog">ChangeLog</a></li> + </ul> + </td> + </tr> + </tbody> + </table> + </td> + </tr> + <tr> + <th bgcolor="#bd2c4a" style="border: 1px solid black; color: white">API Reference</th> + </tr> + <tr> + <td valign="Top"> + + <table border="0" bgcolor="white" width="100%" cellpadding="2" + cellspacing="1" style="border: 1px solid black"> + <tbody> + <tr> + <th bgcolor="#f0f0f0" width="33%">Groups</th> + <th bgcolor="#f0f0f0" width="33%">Namespaces</th> + <th bgcolor="#f0f0f0" width="33%">Full</th> + </tr> + <tr> + <td valign="Top" width="33%"> + <ul> + <li><a href="reference/html/group__signal.html">Signals and Slots</a></li> + <li><a href="reference/html/group__functors.html">Functors</a></li> + <li><a href="reference/html/group__adaptors.html">Adaptors</a></li> + <li><a href="reference/html/group__lamdba.html">Lambda</a></li> + </ul> + </td> + <td valign="Top" width="33%"> + <ul> + <li><a href="reference/html/namespace_sigc.html">sigc</a></li> + <li><a href="reference/html/namespace_sigc__internal.html">sigc::internal</a></li> + <li><a href="reference/html/namespace_sigc__functor.html">sigc::functor</a></li> + <li><a href="reference/html/namespace_sigc__functor__internal.html">sigc::functor::internal</a></li> + </ul> + </td> + <td valign="Top" width="33%"> + <ul> + <li><a href="reference/html/hierarchy.html">Inheritance Hierarchy</a></li> + <li><a href="reference/html/inherits.html">Class Chart (image)</a></li> + <li><a href="reference/html/classes.html">All Classes</a></li> + <li><a href="reference/html/functions.html">All methods (long)</a></li> + </ul> + </td> + </tr> + </tbody> + </table> + + <table cellspacing="1" cellpadding="2" width="100%" border="0"> + <tbody> + <tr> + <th width="33%" bgcolor="#bd2c4a" style="border: 1px solid black; color: white">Others<br> + </th> + </tr> + + </tbody> + </table> + </td> + </tr> + + </tbody> + </table> + <br> + </div> + + </body> +</html> diff --git a/docs/reference/Doxyfile.in b/docs/reference/Doxyfile.in new file mode 100644 index 0000000..b85c39e --- /dev/null +++ b/docs/reference/Doxyfile.in @@ -0,0 +1,183 @@ +# Doxyfile 1.2.13-20030406 + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = libsigc +PROJECT_NUMBER = +OUTPUT_DIRECTORY = +OUTPUT_LANGUAGE = English +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +INTERNAL_DOCS = NO +STRIP_CODE_COMMENTS = NO +CASE_SENSE_NAMES = YES +SHORT_NAMES = NO +HIDE_SCOPE_NAMES = NO +VERBATIM_HEADERS = NO +SHOW_INCLUDE_FILES = NO +JAVADOC_AUTOBRIEF = YES +INHERIT_DOCS = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 8 +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +ALIASES = +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +OPTIMIZE_OUTPUT_FOR_C = NO +SHOW_USED_FILES = YES +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ../../sigc++ ../../sigc++/functors ../../sigc++/adaptors ../../sigc++/adaptors/lambda +FILE_PATTERNS = *.h +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = */wrap_init.h +EXAMPLE_PATH = @top_srcdir@/examples +EXAMPLE_PATTERNS = *.h *.cc +EXAMPLE_RECURSIVE = YES +IMAGE_PATH = $(DOXYGEN_IMAGE_PATH) +INPUT_FILTER = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = libsigc_header.html_fragment +HTML_FOOTER = libsigc_footer.html_fragment +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = YES +ENUM_VALUES_PER_LINE = 1 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +SEARCH_INCLUDES = NO +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \ + LIBSIGC_USING_STD(x)= \ + LIBSIGC_API +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = libsigc_doxygen_tags +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = @PERL_PATH@ +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = NO +TEMPLATE_RELATIONS = NO +HIDE_UNDOC_RELATIONS = NO +INCLUDE_GRAPH = NO +INCLUDED_BY_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1024 +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO +CGI_NAME = search.cgi +CGI_URL = +DOC_URL = +DOC_ABSPATH = +BIN_ABSPATH = +EXT_DOC_PATHS = diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 0000000..4ab91df --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,62 @@ + +doxygen_configfile = Doxyfile +doxygen_configfile_source = $(srcdir)/Doxyfile.in +beautify_docs = $(srcdir)/beautify_docs.pl + +include $(top_srcdir)/docs/Makefile_web.am_fragment +web_path_reference = $(web_path_docs)reference + +EXTRA_DIST = README Doxyfile.in \ + libsigc_header.html_fragment libsigc_footer.html_fragment beautify_docs.pl \ + html + +html/index.html: $(doxygen_configfile_source) $(beautify_docs) + -rm -rf html + doxygen $(doxygen_configfile) + $(PERL_PATH) $(beautify_docs) html + + +libsigc-reference-html.tar.gz: html/index.html + tar cf - html | gzip -c --best >$@ + +libsigc-reference-html.tar.bz2: html/index.html + tar cf - html | bzip2 -c >$@ + +post-html: html/index.html + rsync $(rsync_args) -r html/ $$USER@shell.sourceforge.net:$(web_path_reference)/html/ + +doc-clean: + -rm -rf html + -rm -f libsigc_doxygen_tags + -rm -f libsigc-reference-html.tar.gz libsigc-reference-html.tar.bz2 + +referencedir = $(libsigc_docdir)/reference/html + +install-reference: html/index.html + @$(NORMAL_INSTALL) + $(mkinstalldirs) $(DESTDIR)$(referencedir) + @dir='$(<D)'; for p in $$dir/*.html $$dir/*.css $$dir/*.png $$dir/*.dot ; do \ + f="`echo $$p | sed -e 's|^.*/||'`"; \ + echo " $(INSTALL_DATA) $$p $(DESTDIR)$(referencedir)/$$f"; \ + $(INSTALL_DATA) $$p $(DESTDIR)$(referencedir)/$$f; \ + done + +uninstall-reference: html/index.html + @$(NORMAL_UNINSTALL) + @dir='$(<D)'; for p in $$dir/*.html $$dir/*.css $$dir/*.png $$dir/*.dot ; do \ + f="`echo $$p | sed -e 's|^.*/||'`"; \ + echo " rm -f $(DESTDIR)$(referencedir)/$$f"; \ + rm -f $(DESTDIR)$(referencedir)/$$f; \ + done + + +all-local: html/index.html + +install-data-local: install-reference + +uninstall-local: uninstall-reference + +maintainer-clean-local: doc-clean + +.PHONY: post-html doc-clean install-reference uninstall-reference + diff --git a/docs/reference/README b/docs/reference/README new file mode 100644 index 0000000..ce16435 --- /dev/null +++ b/docs/reference/README @@ -0,0 +1,6 @@ +You need to have doxygen installed. + +make targets: + +all: builds the reference documentation +post-html: uploads it to the sourceforge site.
\ No newline at end of file diff --git a/docs/reference/beautify_docs.pl b/docs/reference/beautify_docs.pl new file mode 100755 index 0000000..e1f4edc --- /dev/null +++ b/docs/reference/beautify_docs.pl @@ -0,0 +1,78 @@ +#! /usr/bin/perl -w + +#sub main() +{ + my $directory = "."; + $directory = $ARGV[0] unless scalar(@ARGV) == 0; + print "processing directory $directory...\n" unless $directory =~ /^\.?$/; + + foreach(`find "$directory" -type f -name '*.html'`) + { + chomp; + /([^\/]+)$/; + print "processing $1...\n"; + &process($_); + } + + exit 0; +} + +sub process($) +{ + my ($file) = @_; + my @outbuf; + + open(FILE, '<', $file); + + while(<FILE>) + { + if(/<a class="el"/) + { + # return value + s/ & /& /; + s/ \* /* /; + + # arg list + s/ &/&/g; + s/&\b/& /g; + s/ \*/*/g; + s/\*\b/* /g; + + # templates + s/\btemplate<\b/template </; + while(s/(.*<) +(.+) +(>.*)/$1$2$3/) {} + } + elsif(/<td class="md(|name)"/) + { + # left parenthesis + s/\( /(/; + + # return value + s/ & /& /g; + s/ \* /* /g; + + # arg list + s/ & /& /g; + s/ \* /* /g; + + # templates + s/\btemplate<\b/template </; + while(s/(.*<) +(.+) +(>.*)/$1$2$3/) {} + } + else + { + # template decls + s/^(|<h\d>)template<\b/$1template </; + } + + push(@outbuf, $_); + } + + open(FILE, '>', $file); + + # write the whole buffer back + print FILE "$_" foreach(@outbuf); + + close(FILE); +} + diff --git a/docs/reference/libsigc_footer.html_fragment b/docs/reference/libsigc_footer.html_fragment new file mode 100644 index 0000000..d66fd99 --- /dev/null +++ b/docs/reference/libsigc_footer.html_fragment @@ -0,0 +1,5 @@ +<hr><address><small> +Generated for $projectname by <a href="http://www.doxygen.org/index.html"> +Doxygen</a> $doxygenversion © 1997-2001</small></address> +</body> +</html> diff --git a/docs/reference/libsigc_header.html_fragment b/docs/reference/libsigc_header.html_fragment new file mode 100644 index 0000000..b866444 --- /dev/null +++ b/docs/reference/libsigc_header.html_fragment @@ -0,0 +1,22 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>$title</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head> +<body bgcolor="#ffffff"> +<table border="0" width="100%"> +<tr> + <td width="10%" height="40"><img src="../../images/libsigc_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td> + <td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td> +</tr> +</table> +<center> + <a class="qindex" href="../../index.html">Main Page</a> + <a href="group__signal.html">Signals and Slots</a> + <a href="group__functors.html">Functors</a> + <a href="group__adaptors.html">Adaptors</a> + <a href="group__lambda.html">Lambda</a> + <a class="qindex" href="namespaces.html"> Namespaces</a> +</center> +<hr width="100%"/> + |
