From 9cab340b154974546d6c08d01f01569a9385d8cb Mon Sep 17 00:00:00 2001 From: wolf Date: Thu, 11 Feb 1999 09:03:06 +0000 Subject: [PATCH] Move most of the documentation from the individual libraries to a common subdirectory. This makes maintenance and automatic generation of documentation as well as proper cross-referencing much easier. git-svn-id: https://svn.dealii.org/trunk@779 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/auto/Makefile | 88 +++++++++++++++++++++++ deal.II/doc/auto/cvs-backlog/.cvsignore | 1 + deal.II/doc/auto/kdoc/.cvsignore | 1 + deal.II/doc/auto/kdoc/base/.cvsignore | 1 + deal.II/doc/auto/kdoc/basic/.cvsignore | 1 + deal.II/doc/auto/kdoc/dof/.cvsignore | 1 + deal.II/doc/auto/kdoc/grid/.cvsignore | 1 + deal.II/doc/auto/kdoc/lac/.cvsignore | 1 + deal.II/doc/auto/kdoc/numerics/.cvsignore | 1 + 9 files changed, 96 insertions(+) create mode 100644 deal.II/doc/auto/Makefile create mode 100644 deal.II/doc/auto/cvs-backlog/.cvsignore create mode 100644 deal.II/doc/auto/kdoc/.cvsignore create mode 100644 deal.II/doc/auto/kdoc/base/.cvsignore create mode 100644 deal.II/doc/auto/kdoc/basic/.cvsignore create mode 100644 deal.II/doc/auto/kdoc/dof/.cvsignore create mode 100644 deal.II/doc/auto/kdoc/grid/.cvsignore create mode 100644 deal.II/doc/auto/kdoc/lac/.cvsignore create mode 100644 deal.II/doc/auto/kdoc/numerics/.cvsignore diff --git a/deal.II/doc/auto/Makefile b/deal.II/doc/auto/Makefile new file mode 100644 index 0000000000..eb2b584ef3 --- /dev/null +++ b/deal.II/doc/auto/Makefile @@ -0,0 +1,88 @@ +# $Id$ + +KDOCFLAGS = -I../scripts/kdoc ../scripts/kdoc/kdoc -a -p +KDOCINCLUDE = -lbase -llac -lbasic -lgrid -ldof -lnumerics + +kdoc.base = $(wildcard ../../base/include/base/*.h) +kdoc.lac = $(wildcard ../../lac/include/lac/*.h) +kdoc.basic= $(wildcard ../../deal.II/include/basic/*.h) +kdoc.grid = $(wildcard ../../deal.II/include/grid/tria*.h) ../../deal.II/include/grid/geometry_info.h +kdoc.dof = $(wildcard ../../deal.II/include/grid/dof*.h) \ + $(wildcard ../../deal.II/include/grid/mg_*.h) \ + $(wildcard ../../deal.II/include/fe/*.h) +kdoc.num = $(wildcard ../../deal.II/include/numerics/*.h) + +kdoc.all = $(kdoc.base) $(kdoc.lac) $(kdoc.basic) $(kdoc.grid) $(kdoc.dof) $(kdoc.num) + +all-include-files = $(wildcard ../../deal.II/include/*/*.h \ + ../../lac/include/lac/*.h \ + ../../base/include/base/*.h) + + + +default: kdoc kdoc/names.html +all: default cvslog + +cvslog: + cd ../.. ; perl doc/auto/scripts/cvs2html -o doc/auto/cvs-backlog/newdeal -a -k -D 100 + + +# make sure that the *.kdoc files exist by +# using the dependancies and the following rules. +kdoc: kdoc/basic.kdoc kdoc/grid.kdoc kdoc/dof.kdoc kdoc/numerics.kdoc $(kdoc.all) kdoc-rerun + +kdoc-rerun: + @cd kdoc ; perl $(KDOCFLAGS) $(KDOCINCLUDE) -dbase \ + base $(kdoc.base:../..%=../../..%) + @cd kdoc ; perl $(KDOCFLAGS) $(KDOCINCLUDE) -dlac \ + lac $(kdoc.lac:../..%=../../..%) + @cd kdoc ; perl $(KDOCFLAGS) $(KDOCINCLUDE) -dbasic \ + basic $(kdoc.basic:../..%=../../..%) + @cd kdoc ; perl $(KDOCFLAGS) $(KDOCINCLUDE) -dgrid \ + grid $(kdoc.grid:../..%=../../..%) + @cd kdoc ; perl $(KDOCFLAGS) $(KDOCINCLUDE) -ddof \ + dof $(kdoc.dof:../..%=../../..%) + @cd kdoc ; perl $(KDOCFLAGS) $(KDOCINCLUDE) -dnumerics \ + numerics $(kdoc.num:../..%=../../..%) +# output the names of the files which were not processed since they should +# be added to one of the above lists. + @echo ------------------------------------------------------------- + @echo Unprocessed include files: + @echo " " $(filter-out $(kdoc.all), $(all-include-files)) + + +kdoc/base.kdoc: $(kdoc.base) + @cd kdoc ; perl $(KDOCFLAGS) -dbase \ + base $(kdoc.base:../..%=../../..%) + +kdoc/lac.kdoc: $(kdoc.lac) + @cd kdoc ; perl $(KDOCFLAGS) -dlac \ + lac $(kdoc.lac:../..%=../../..%) + +kdoc/basic.kdoc: $(kdoc.basic) + @cd kdoc ; perl $(KDOCFLAGS) -dbasic \ + basic $(kdoc.basic:../..%=../../..%) + +kdoc/grid.kdoc: $(kdoc.grid) + @cd kdoc ; perl $(KDOCFLAGS) -dgrid \ + grid $(kdoc.grid:../..%=../../..%) + +kdoc/dof.kdoc: $(kdoc.tria) + @cd kdoc ; perl $(KDOCFLAGS) -ddof \ + dof $(kdoc.dof:../..%=../../..%) + +kdoc/numerics.kdoc: $(kdoc.num) + @cd kdoc ; perl $(KDOCFLAGS) -dnumerics \ + numerics $(kdoc.num:../..%=../../..%) + + +kdoc/names.html: kdoc/base.kdoc kdoc/lac.kdoc kdoc/basic.kdoc kdoc/grid.kdoc kdoc/dof.kdoc kdoc/numerics.kdoc + @cd kdoc ; perl ../scripts/index.pl *.kdoc > names.html + + +clean: + -rm -f kdoc/names.html kdoc/*.kdoc kdoc/*/*.html cvs-backlog/*.html + + + +.PHONY: default all kdoc-rerun clean \ No newline at end of file diff --git a/deal.II/doc/auto/cvs-backlog/.cvsignore b/deal.II/doc/auto/cvs-backlog/.cvsignore new file mode 100644 index 0000000000..2d19fc766d --- /dev/null +++ b/deal.II/doc/auto/cvs-backlog/.cvsignore @@ -0,0 +1 @@ +*.html diff --git a/deal.II/doc/auto/kdoc/.cvsignore b/deal.II/doc/auto/kdoc/.cvsignore new file mode 100644 index 0000000000..2018d05302 --- /dev/null +++ b/deal.II/doc/auto/kdoc/.cvsignore @@ -0,0 +1 @@ +*.kdoc names.html diff --git a/deal.II/doc/auto/kdoc/base/.cvsignore b/deal.II/doc/auto/kdoc/base/.cvsignore new file mode 100644 index 0000000000..2d19fc766d --- /dev/null +++ b/deal.II/doc/auto/kdoc/base/.cvsignore @@ -0,0 +1 @@ +*.html diff --git a/deal.II/doc/auto/kdoc/basic/.cvsignore b/deal.II/doc/auto/kdoc/basic/.cvsignore new file mode 100644 index 0000000000..2d19fc766d --- /dev/null +++ b/deal.II/doc/auto/kdoc/basic/.cvsignore @@ -0,0 +1 @@ +*.html diff --git a/deal.II/doc/auto/kdoc/dof/.cvsignore b/deal.II/doc/auto/kdoc/dof/.cvsignore new file mode 100644 index 0000000000..2d19fc766d --- /dev/null +++ b/deal.II/doc/auto/kdoc/dof/.cvsignore @@ -0,0 +1 @@ +*.html diff --git a/deal.II/doc/auto/kdoc/grid/.cvsignore b/deal.II/doc/auto/kdoc/grid/.cvsignore new file mode 100644 index 0000000000..2d19fc766d --- /dev/null +++ b/deal.II/doc/auto/kdoc/grid/.cvsignore @@ -0,0 +1 @@ +*.html diff --git a/deal.II/doc/auto/kdoc/lac/.cvsignore b/deal.II/doc/auto/kdoc/lac/.cvsignore new file mode 100644 index 0000000000..2d19fc766d --- /dev/null +++ b/deal.II/doc/auto/kdoc/lac/.cvsignore @@ -0,0 +1 @@ +*.html diff --git a/deal.II/doc/auto/kdoc/numerics/.cvsignore b/deal.II/doc/auto/kdoc/numerics/.cvsignore new file mode 100644 index 0000000000..2d19fc766d --- /dev/null +++ b/deal.II/doc/auto/kdoc/numerics/.cvsignore @@ -0,0 +1 @@ +*.html -- 2.39.5