From 60dc2b7bbe39af6dfc8a9a8ddb48e32b19862bc6 Mon Sep 17 00:00:00 2001 From: David Daniel Date: Fri, 26 Mar 2004 02:25:41 +0000 Subject: [PATCH] Changing Doxyfile so that doxygen will scan files matching the pattern *.dox. Also adding files src/README.dox indicating how to add documentation to the "main page", and src/mpi/README.dox as an example of adding a page of supplementary information. Don't know if there is a "standard" way of doing this, but it seems to work, and saves us having to stuff too much detail into real source files. This commit was SVN r964. --- Doxyfile | 2 +- src/README.dox | 23 +++++++++++++++++++++++ src/mpi/README.dox | 15 +++++++++++++++ 3 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 src/README.dox create mode 100644 src/mpi/README.dox diff --git a/Doxyfile b/Doxyfile index c3c223797b..ed284ab59a 100644 --- a/Doxyfile +++ b/Doxyfile @@ -372,7 +372,7 @@ INPUT = # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc -FILE_PATTERNS = *.c *.h *.cc +FILE_PATTERNS = *.c *.h *.cc *.dox # 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. diff --git a/src/README.dox b/src/README.dox new file mode 100644 index 0000000000..42d0ab0c65 --- /dev/null +++ b/src/README.dox @@ -0,0 +1,23 @@ +/** @mainpage + +@section mainpage_introduction Introduction + +This is the introduction. +This is the introduction. +This is the introduction. +This is the introduction. +This is the introduction. +This is the introduction. +This is the introduction. + +@section main_install Installation + +This is the installation section. +This is the installation section. +This is the installation section. +This is the installation section. +This is the installation section. +This is the installation section. +This is the installation section. + +*/ diff --git a/src/mpi/README.dox b/src/mpi/README.dox new file mode 100644 index 0000000000..5ec69767f1 --- /dev/null +++ b/src/mpi/README.dox @@ -0,0 +1,15 @@ +/** + +@page page_mpi The src/mpi directory + +@section page_mpi_introduction Introduction + +This is the introduction. +This is the introduction. +This is the introduction. +This is the introduction. +This is the introduction. +This is the introduction. +This is the introduction. + +*/