New files for the Doxygen source code documentation system.
authorAlexander Barton <alex@barton.de>
Fri, 22 Jul 2005 20:58:22 +0000 (20:58 +0000)
committerAlexander Barton <alex@barton.de>
Fri, 22 Jul 2005 20:58:22 +0000 (20:58 +0000)
doc/src/Doxyfile [new file with mode: 0644]
doc/src/Makefile.am [new file with mode: 0644]
doc/src/footer.inc.html [new file with mode: 0644]
doc/src/header.inc.html [new file with mode: 0644]
doc/src/ngircd-doc.css [new file with mode: 0644]

diff --git a/doc/src/Doxyfile b/doc/src/Doxyfile
new file mode 100644 (file)
index 0000000..1434103
--- /dev/null
@@ -0,0 +1,144 @@
+#
+# ngIRCd -- The Next Generation IRC Daemon
+# Copyright (c)2001-2005 Alexander Barton (alex@barton.de)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+# Please read the file COPYING, README and AUTHORS for more information.
+#
+# $Id: Doxyfile,v 1.1 2005/07/22 20:58:22 alex Exp $
+#
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for ngIRCd.
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
+# by quotes) that should identify the project.
+
+PROJECT_NAME           = ngIRCd
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
+# base path where the generated documentation will be put. 
+# If a relative path is entered, it will be relative to the location 
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY       = .
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
+# will interpret the first line (until the first dot) of a JavaDoc-style 
+# comment as the brief description. If set to NO, the JavaDoc 
+# comments will behave just like the Qt-style comments (thus requiring an 
+# explicit @brief command for a brief description.
+
+JAVADOC_AUTOBRIEF      = YES
+
+# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
+# will output the detailed description near the top, like JavaDoc.
+# If set to NO, the detailed description appears after the member 
+# documentation.
+
+DETAILS_AT_TOP         = NO
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
+# sources only. Doxygen will then generate output that is more tailored for C. 
+# For instance, some of the names that are used will be different. The list 
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C  = YES
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
+# documentation are documented, even if no documentation was available. 
+# Private class members and static file members will be hidden unless 
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL            = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
+# will be included in the documentation.
+
+EXTRACT_PRIVATE        = YES
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file 
+# will be included in the documentation.
+
+EXTRACT_STATIC         = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
+# defined locally in source files will be included in the documentation. 
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES  = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that
+# contain documented source files. You may enter file names like "myfile.cpp"
+# or directories like "/usr/src/myproject". Separate the files or directories 
+# with spaces.
+
+INPUT                  = ../../src
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
+# should be searched for input files as well. Possible values are YES and NO. 
+# If left blank NO is used.
+
+RECURSIVE              = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
+# be generated. Documented entities will be cross-referenced with these sources. 
+# Note: To get rid of all source code in the generated output, make sure also 
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER         = YES
+
+#---------------------------------------------------------------------------
+# Output formats
+#---------------------------------------------------------------------------
+
+GENERATE_HTML          = YES
+
+HTML_OUTPUT            = html
+HTML_FILE_EXTENSION    = .html
+HTML_HEADER            = header.inc.html
+HTML_FOOTER            = footer.inc.html
+HTML_STYLESHEET        = ngircd-doc.css
+
+GENERATE_HTMLHELP      = NO
+GENERATE_LATEX         = NO
+GENERATE_RTF           = NO
+GENERATE_MAN           = NO
+GENERATE_XML           = NO
+GENERATE_AUTOGEN_DEF   = NO
+GENERATE_PERLMOD       = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor   
+#---------------------------------------------------------------------------
+
+# The PREDEFINED tag can be used to specify one or more macro names that 
+# are defined before the preprocessor is started (similar to the -D option of 
+# gcc). The argument of the tag is a list of macros of the form: name 
+# or name=definition (no spaces). If the definition and the = are 
+# omitted =1 is assumed. To prevent a macro definition from being 
+# undefined via #undef or recursively expanded use the := operator 
+# instead of the = operator.
+
+PREDEFINED             = CONN_MODULE __client_c__
+
+# -eof-
diff --git a/doc/src/Makefile.am b/doc/src/Makefile.am
new file mode 100644 (file)
index 0000000..a399269
--- /dev/null
@@ -0,0 +1,22 @@
+#
+# ngIRCd -- The Next Generation IRC Daemon
+# Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+# Please read the file COPYING, README and AUTHORS for more information.
+#
+# $Id: Makefile.am,v 1.1 2005/07/22 20:58:22 alex Exp $
+#
+
+distclean-local:
+       rm -f html
+
+srcdoc:
+       @doxygen --version >/dev/null 2>&1 \
+         || ( echo; echo "Error: \"doxygen\" not found!"; echo; exit 1 )
+       doxygen
+
+# -eof-
diff --git a/doc/src/footer.inc.html b/doc/src/footer.inc.html
new file mode 100644 (file)
index 0000000..c967b04
--- /dev/null
@@ -0,0 +1,11 @@
+
+<hr class="footer">
+<p>
+  ngIRCd
+  <a href="http://ngircd.barton.de/">Homepage</a>,
+  <a href="http://arthur.barton.de/cgi-bin/viewcvs.cgi/ngircd/">CVS-Repository</a>,
+  <a href="http://ngircd.barton.de/bugzilla/index.cgi">Bug-Tracker</a>.
+</p>
+
+</body>
+</html>
diff --git a/doc/src/header.inc.html b/doc/src/header.inc.html
new file mode 100644 (file)
index 0000000..592c016
--- /dev/null
@@ -0,0 +1,10 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+
+<head>
+  <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+  <title>ngIRCd Source Documentation</title>
+  <link href="ngircd-doc.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+
diff --git a/doc/src/ngircd-doc.css b/doc/src/ngircd-doc.css
new file mode 100644 (file)
index 0000000..185bf3b
--- /dev/null
@@ -0,0 +1,69 @@
+/*
+ * Cascading Style Sheet for the ngIRCd source documentation
+ *
+ * $Id: ngircd-doc.css,v 1.1 2005/07/22 20:58:22 alex Exp $
+ */
+
+BODY {
+       background-color: white;
+       color: black;
+       margin: 30px;
+       font-family: Geneva, sans-serif;
+       font-size: 12px;
+}
+
+A:visited { color: purple; background: transparent; }
+A:link { color: navy; background: transparent; }
+A:active { color: red; background: transparent; }
+A:hover { background: #ffa; }
+
+H1, H2, H3 {
+       font-family: Verdana, sans-serif;
+       background-color: white;
+       color: #005555;
+}
+H1 { margin-bottom: 10px; }
+H2 {
+       margin-top: 20px;
+       margin-bottom: 10px;
+}
+
+P, LI, TD, TH, DT {
+       font-family: Geneva, sans-serif;
+       font-size: 12px;
+       line-height: 1.2
+}
+
+DD { margin-bottom: 1em; }
+
+UL { list-style-type: square; }
+
+HR { margin: 2em 0px; }
+
+BODY>TABLE { padding: 1em 0px; }
+
+TD.mdRow {
+       border: 1px dotted silver;
+       background-color: #fff9dd;
+}
+
+TD.md { font-weight: bold; }
+
+TD.memItemLeft { padding-top: 4px; }
+TD.memItemRight { padding-top: 4px; }
+TD.mdescRight { font-style: italic; }
+
+DIV.qindex {
+       background-color: #eee;
+       border: 1px dotted silver;
+       padding: 3px;
+       margin-bottom: 2px;
+}
+
+DIV.nav {
+       margin: 1em 0px;
+}
+
+HR.footer { margin-top: 50px; }
+
+/* -eof- */