From 53598070ea2c9e71fbe412374b6af53c4b913423 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Fri, 13 Jan 2006 23:11:43 +0000 Subject: [PATCH] Only one entry point into the documentation, instead of base, lac, and all. git-svn-id: https://svn.dealii.org/trunk@12017 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/doxygen/Makefile.in | 43 +++++++++++++++++---------------- deal.II/doc/doxygen/deal.dox | 2 +- 2 files changed, 23 insertions(+), 22 deletions(-) diff --git a/deal.II/doc/doxygen/Makefile.in b/deal.II/doc/doxygen/Makefile.in index 9f488d0af0..ae4373b8f4 100644 --- a/deal.II/doc/doxygen/Makefile.in +++ b/deal.II/doc/doxygen/Makefile.in @@ -17,15 +17,18 @@ private: perl -pi -e 's/(EXTRACT_PRIVATE\s*=\s*)NO/$$1YES/;s/(INTERNAL_DOCS\s*=\s*)NO/$$1YES/;' options.dox $(MAKE) html -%.tag: %.dox - @DOXYGEN@ $< +# generate documentation. write the output to a file so as not to hide the +# important message to impatient observers that this process can take quite +# a while +deal.tag: deal.dox \ + $D/base/include/*/*.h \ + $D/lac/include/*/*.h \ + $D/deal.II/include/*/*.h \ + headers/*.h + @echo "=== Generating reference documentation. " \ + "This can take several minutes..." + @DOXYGEN@ deal.dox > doxygen.log -base.tag: @prefix@/base/include/*/*.h headers/base/*.h -lac.tag: base.tag @prefix@/lac/include/*/*.h headers/lac/*.h -deal.tag: lac.tag @prefix@/deal.II/include/*/*.h headers/deal.II/*.h - -base: base.tag -lac: lac.tag deal.II: deal.tag # validate cross references. there are so many html files in these @@ -33,20 +36,18 @@ deal.II: deal.tag # $(PERL) $D/common/scripts/validate-xrefs.pl deal.II/*.html # as this leads to error messages of the kind "/usr/bin/perl: Argument # list too long". Instead, use a loop over all html files -validate-xrefs-%: - @echo --- Validating xrefs in $(@:validate-xrefs-%=%)/ --- - cd $(@:validate-xrefs-%=%) ; \ +validate-xrefs: + @echo --- Validating xrefs in doxygen/deal.II/ --- + @cd deal.II ; \ for i in *.html ; do \ - $(PERL) $D/common/scripts/validate-xrefs.pl $i ; \ + $(PERL) $D/common/scripts/validate-xrefs.pl $$i ; \ done -validate-xrefs: validate-xrefs-base \ - validate-xrefs-lac \ - validate-xrefs-deal.II - +# we have so many files that we can't just do "rm deal.II/*" because that +# leads to overlong command lines. gotta split it up +clean: + for i in {base,lac,deal.II}/* ; do rm $$i ; done + rm *.tag -.PHONY: html private base lac deal.II \ - validate-xrefs \ - validate-xrefs-base \ - validate-xrefs-lac \ - validate-xrefs-deal.II +.PHONY: html private deal.II \ + validate-xrefs clean diff --git a/deal.II/doc/doxygen/deal.dox b/deal.II/doc/doxygen/deal.dox index 5639e1134b..a57e32c72f 100644 --- a/deal.II/doc/doxygen/deal.dox +++ b/deal.II/doc/doxygen/deal.dox @@ -2,7 +2,7 @@ PROJECT_NAME = "deal.II library" -INPUT = headers/base/ headers/lac/ headers/deal.II/ \ +INPUT = headers/ \ ../../base/include/base \ ../../lac/include/lac \ ../../deal.II/include/dofs \ -- 2.39.5