]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
First setup for doxygen documentation
authorguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 1 Aug 2003 23:42:55 +0000 (23:42 +0000)
committerguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 1 Aug 2003 23:42:55 +0000 (23:42 +0000)
git-svn-id: https://svn.dealii.org/trunk@7896 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/doxygen/.cvsignore [new file with mode: 0644]
deal.II/doc/doxygen/Makefile [new file with mode: 0644]
deal.II/doc/doxygen/base.dox [new file with mode: 0644]
deal.II/doc/doxygen/deal.dox [new file with mode: 0644]
deal.II/doc/doxygen/headers/base/dox.h [new file with mode: 0644]
deal.II/doc/doxygen/headers/deal.II/dox.h [new file with mode: 0644]
deal.II/doc/doxygen/headers/lac/dox.h [new file with mode: 0644]
deal.II/doc/doxygen/lac.dox [new file with mode: 0644]
deal.II/doc/doxygen/options.dox [new file with mode: 0644]

diff --git a/deal.II/doc/doxygen/.cvsignore b/deal.II/doc/doxygen/.cvsignore
new file mode 100644 (file)
index 0000000..3c7c1f2
--- /dev/null
@@ -0,0 +1,2 @@
+base lac deal.II
+*.tag
diff --git a/deal.II/doc/doxygen/Makefile b/deal.II/doc/doxygen/Makefile
new file mode 100644 (file)
index 0000000..2bcbd5c
--- /dev/null
@@ -0,0 +1,19 @@
+# $Id$
+# $Name$
+#
+# Copyright (c) the deal.II authors 2003
+
+html: deal.tag
+
+%.tag: %.dox
+       doxygen $<
+
+base.tag: ../../base/include/*/*.h headers/base/*.h
+lac.tag:  base.tag ../../lac/include/*/*.h headers/lac/*.h
+deal.tag: lac.tag  ../../deal.II/include/*/*.h headers/deal.II/*.h
+
+base:    base.tag
+lac:     lac.tag
+deal.II: deal.tag
+
+.PHONY: html base lac deal.II
diff --git a/deal.II/doc/doxygen/base.dox b/deal.II/doc/doxygen/base.dox
new file mode 100644 (file)
index 0000000..6262a3d
--- /dev/null
@@ -0,0 +1,10 @@
+@INCLUDE = options.dox
+
+PROJECT_NAME = "deal.II base library"
+
+INPUT    = headers/base/ ../../base/include/base/
+TAGFILES = base.tag
+
+HTML_OUTPUT      = base
+LATEX_OUTPUT     = latex/base
+GENERATE_TAGFILE = base.tag
diff --git a/deal.II/doc/doxygen/deal.dox b/deal.II/doc/doxygen/deal.dox
new file mode 100644 (file)
index 0000000..776ffc5
--- /dev/null
@@ -0,0 +1,15 @@
+@INCLUDE = options.dox
+
+PROJECT_NAME = "deal.II library"
+
+INPUT    = headers/deal.II/ \
+       ../../deal.II/include/dofs \
+       ../../deal.II/include/fe \
+       ../../deal.II/include/grid \
+       ../../deal.II/include/multigrid \
+       ../../deal.II/include/numerics
+TAGFILES = base.tag lac.tag
+
+HTML_OUTPUT      = deal.II
+LATEX_OUTPUT     = latex/deal.II
+GENERATE_TAGFILE = deal.tag
diff --git a/deal.II/doc/doxygen/headers/base/dox.h b/deal.II/doc/doxygen/headers/base/dox.h
new file mode 100644 (file)
index 0000000..0816621
--- /dev/null
@@ -0,0 +1,13 @@
+//-------------------------------------------------------------------------
+//    $Id$
+//    Version: $Name$
+//
+//    Copyright (C) 2003 by the deal.II authors
+//
+//    This file is subject to QPL and may not be  distributed
+//    without copyright and license information. Please refer
+//    to the file deal.II/doc/license.html for the  text  and
+//    further information on this license.
+//
+//-------------------------------------------------------------------------
+
diff --git a/deal.II/doc/doxygen/headers/deal.II/dox.h b/deal.II/doc/doxygen/headers/deal.II/dox.h
new file mode 100644 (file)
index 0000000..0816621
--- /dev/null
@@ -0,0 +1,13 @@
+//-------------------------------------------------------------------------
+//    $Id$
+//    Version: $Name$
+//
+//    Copyright (C) 2003 by the deal.II authors
+//
+//    This file is subject to QPL and may not be  distributed
+//    without copyright and license information. Please refer
+//    to the file deal.II/doc/license.html for the  text  and
+//    further information on this license.
+//
+//-------------------------------------------------------------------------
+
diff --git a/deal.II/doc/doxygen/headers/lac/dox.h b/deal.II/doc/doxygen/headers/lac/dox.h
new file mode 100644 (file)
index 0000000..6b24734
--- /dev/null
@@ -0,0 +1,55 @@
+//-------------------------------------------------------------------------
+//    $Id$
+//    Version: $Name$
+//
+//    Copyright (C) 2003 by the deal.II authors
+//
+//    This file is subject to QPL and may not be  distributed
+//    without copyright and license information. Please refer
+//    to the file deal.II/doc/license.html for the  text  and
+//    further information on this license.
+//
+//-------------------------------------------------------------------------
+
+/**
+ * @defgroup LAC The Linear Algebra Classes
+ * @brief All the classes for linear algebra
+ * Bla bla bla
+ * @{
+ */
+
+/**
+ * @defgroup Solvers Linear Solver classes
+ *
+ * Here we collect iterative solvers and some control classes. All
+ * solvers inherit from the class template Solver, which provides some
+ * basic maintenance methods.
+ *
+ * The number of iteration steps of all solvers is controlled by
+ * objects of class SolverControl or its derived class
+ * ReductionControl.
+ */
+
+/**
+ * @defgroup Matrices Matrix classes
+ * @{
+ */
+
+/**
+ * @defgroup Matrix1 Basic matrices
+ */
+
+
+/**
+ * @defgroup Matrix2 Derived matrices
+ */
+
+/**
+ * @defgroup Preconditioners Preconditioners
+ * @}
+ */
+
+
+/**
+ * @}
+ */
diff --git a/deal.II/doc/doxygen/lac.dox b/deal.II/doc/doxygen/lac.dox
new file mode 100644 (file)
index 0000000..121de93
--- /dev/null
@@ -0,0 +1,10 @@
+@INCLUDE = options.dox
+
+PROJECT_NAME = "deal.II Linear Algebra Classes (LAC) library"
+
+INPUT    = headers/lac/ ../../lac/include/lac/
+TAGFILES = base.tag
+
+HTML_OUTPUT      = lac
+LATEX_OUTPUT     = latex/lac
+GENERATE_TAGFILE = lac.tag
diff --git a/deal.II/doc/doxygen/options.dox b/deal.II/doc/doxygen/options.dox
new file mode 100644 (file)
index 0000000..05ab094
--- /dev/null
@@ -0,0 +1,171 @@
+# Doxyfile 0.1
+
+#---------------------------------------------------------------------------
+# General configuration options
+#---------------------------------------------------------------------------
+PROJECT_NUMBER         = 4.0
+OUTPUT_DIRECTORY       = .
+OUTPUT_LANGUAGE        = English
+EXTRACT_ALL            = NO
+EXTRACT_PRIVATE        = YES
+EXTRACT_STATIC         = YES
+EXTRACT_LOCAL_CLASSES  = YES
+HIDE_UNDOC_MEMBERS     = YES
+HIDE_UNDOC_CLASSES     = YES
+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    = YES
+CASE_SENSE_NAMES       = YES
+SHORT_NAMES            = NO
+HIDE_SCOPE_NAMES       = NO
+VERBATIM_HEADERS       = NO
+SHOW_INCLUDE_FILES     = NO
+JAVADOC_AUTOBRIEF      = NO
+INHERIT_DOCS           = YES
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = NO
+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        = NO
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = YES
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LOGFILE           = 
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+FILE_PATTERNS          = 
+RECURSIVE              = NO
+EXCLUDE                = 
+EXCLUDE_PATTERNS       = *.templates.h
+EXAMPLE_PATH           = 
+EXAMPLE_PATTERNS       = 
+EXAMPLE_RECURSIVE      = NO
+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    = 3
+IGNORE_PREFIX          = 
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML          = YES
+HTML_HEADER            = 
+HTML_FOOTER            = 
+HTML_STYLESHEET        = 
+HTML_ALIGN_MEMBERS     = NO
+GENERATE_HTMLHELP      = NO
+GENERATE_CHI           = NO
+BINARY_TOC             = NO
+TOC_EXPAND             = NO
+DISABLE_INDEX          = NO
+ENUM_VALUES_PER_LINE   = 4
+GENERATE_TREEVIEW      = NO
+TREEVIEW_WIDTH         = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX         = NO
+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        = YES
+INCLUDE_PATH           = 
+INCLUDE_FILE_PATTERNS  = 
+PREDEFINED             = 
+EXPAND_AS_DEFINED      = 
+SKIP_FUNCTION_MACROS   = YES
+#---------------------------------------------------------------------------
+# Configuration::addtions related to external references   
+#---------------------------------------------------------------------------
+ALLEXTERNALS           = NO
+PERL_PATH              = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool   
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS         = YES
+HAVE_DOT               = NO
+CLASS_GRAPH            = YES
+COLLABORATION_GRAPH    = YES
+TEMPLATE_RELATIONS     = YES
+HIDE_UNDOC_RELATIONS   = YES
+INCLUDE_GRAPH          = YES
+INCLUDED_BY_GRAPH      = YES
+GRAPHICAL_HIERARCHY    = YES
+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            = /usr/local/bin/
+EXT_DOC_PATHS          = 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.