diff options
-rw-r--r-- | docs/AliasAnalysis.html (renamed from docs/main/AliasAnalysis.html) | 0 | ||||
-rw-r--r-- | docs/BitCodeFormat.html (renamed from docs/main/BitCodeFormat.html) | 0 | ||||
-rw-r--r-- | docs/Bugpoint.html (renamed from docs/main/Bugpoint.html) | 0 | ||||
-rw-r--r-- | docs/CFEBuildInstrs.html (renamed from docs/main/CFEBuildInstrs.html) | 0 | ||||
-rw-r--r-- | docs/CMake.html (renamed from docs/main/CMake.html) | 0 | ||||
-rw-r--r-- | docs/CodeGenerator.html (renamed from docs/main/CodeGenerator.html) | 0 | ||||
-rw-r--r-- | docs/CodingStandards.html (renamed from docs/main/CodingStandards.html) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/FileCheck.pod (renamed from docs/main/CommandGuide/FileCheck.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/Makefile | 103 | ||||
-rw-r--r-- | docs/CommandGuide/bugpoint.pod (renamed from docs/main/CommandGuide/bugpoint.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/html/manpage.css | 256 | ||||
-rw-r--r-- | docs/CommandGuide/index.html (renamed from docs/main/CommandGuide/index.html) | 44 | ||||
-rw-r--r-- | docs/CommandGuide/lit.pod (renamed from docs/main/CommandGuide/lit.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llc.pod (renamed from docs/main/CommandGuide/llc.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/lli.pod (renamed from docs/main/CommandGuide/lli.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-ar.pod (renamed from docs/main/CommandGuide/llvm-ar.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-as.pod (renamed from docs/main/CommandGuide/llvm-as.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-bcanalyzer.pod (renamed from docs/main/CommandGuide/llvm-bcanalyzer.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-config.pod (renamed from docs/main/CommandGuide/llvm-config.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-dis.pod (renamed from docs/main/CommandGuide/llvm-dis.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-extract.pod (renamed from docs/main/CommandGuide/llvm-extract.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-ld.pod (renamed from docs/main/CommandGuide/llvm-ld.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-link.pod (renamed from docs/main/CommandGuide/llvm-link.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-nm.pod (renamed from docs/main/CommandGuide/llvm-nm.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-prof.pod (renamed from docs/main/CommandGuide/llvm-prof.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvm-ranlib.pod (renamed from docs/main/CommandGuide/llvm-ranlib.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvmc.pod (renamed from docs/main/CommandGuide/llvmc.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvmgcc.pod (renamed from docs/main/CommandGuide/llvmgcc.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/llvmgxx.pod (renamed from docs/main/CommandGuide/llvmgxx.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/manpage.css (renamed from docs/main/CommandGuide/manpage.css) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/opt.pod (renamed from docs/main/CommandGuide/opt.pod) | 0 | ||||
-rw-r--r-- | docs/CommandGuide/tblgen.pod (renamed from docs/main/CommandGuide/tblgen.pod) | 0 | ||||
-rw-r--r-- | docs/CommandLine.html (renamed from docs/main/CommandLine.html) | 0 | ||||
-rw-r--r-- | docs/CompilerDriver.html (renamed from docs/main/CompilerDriver.html) | 0 | ||||
-rw-r--r-- | docs/CompilerDriverTutorial.html (renamed from docs/main/CompilerDriverTutorial.html) | 0 | ||||
-rw-r--r-- | docs/CompilerWriterInfo.html (renamed from docs/main/CompilerWriterInfo.html) | 0 | ||||
-rw-r--r-- | docs/DebuggingJITedCode.html (renamed from docs/main/DebuggingJITedCode.html) | 0 | ||||
-rw-r--r-- | docs/DeveloperPolicy.html (renamed from docs/main/DeveloperPolicy.html) | 0 | ||||
-rw-r--r-- | docs/ExceptionHandling.html (renamed from docs/main/ExceptionHandling.html) | 0 | ||||
-rw-r--r-- | docs/ExtendedIntegerResults.txt (renamed from docs/main/ExtendedIntegerResults.txt) | 0 | ||||
-rw-r--r-- | docs/ExtendingLLVM.html (renamed from docs/main/ExtendingLLVM.html) | 0 | ||||
-rw-r--r-- | docs/FAQ.html (renamed from docs/main/FAQ.html) | 0 | ||||
-rw-r--r-- | docs/GCCFEBuildInstrs.html (renamed from docs/main/GCCFEBuildInstrs.html) | 0 | ||||
-rw-r--r-- | docs/GarbageCollection.html (renamed from docs/main/GarbageCollection.html) | 0 | ||||
-rw-r--r-- | docs/GetElementPtr.html (renamed from docs/main/GetElementPtr.html) | 0 | ||||
-rw-r--r-- | docs/GettingStarted.html (renamed from docs/main/GettingStarted.html) | 0 | ||||
-rw-r--r-- | docs/GettingStartedVS.html (renamed from docs/main/GettingStartedVS.html) | 0 | ||||
-rw-r--r-- | docs/GoldPlugin.html (renamed from docs/main/GoldPlugin.html) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2000-11-18-EarlyDesignIdeas.txt (renamed from docs/main/HistoricalNotes/2000-11-18-EarlyDesignIdeas.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2000-11-18-EarlyDesignIdeasResp.txt (renamed from docs/main/HistoricalNotes/2000-11-18-EarlyDesignIdeasResp.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2000-12-06-EncodingIdea.txt (renamed from docs/main/HistoricalNotes/2000-12-06-EncodingIdea.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2000-12-06-MeetingSummary.txt (renamed from docs/main/HistoricalNotes/2000-12-06-MeetingSummary.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-01-31-UniversalIRIdea.txt (renamed from docs/main/HistoricalNotes/2001-01-31-UniversalIRIdea.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-02-06-TypeNotationDebate.txt (renamed from docs/main/HistoricalNotes/2001-02-06-TypeNotationDebate.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp1.txt (renamed from docs/main/HistoricalNotes/2001-02-06-TypeNotationDebateResp1.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp2.txt (renamed from docs/main/HistoricalNotes/2001-02-06-TypeNotationDebateResp2.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp4.txt (renamed from docs/main/HistoricalNotes/2001-02-06-TypeNotationDebateResp4.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-02-09-AdveComments.txt (renamed from docs/main/HistoricalNotes/2001-02-09-AdveComments.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt (renamed from docs/main/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-02-13-Reference-Memory.txt (renamed from docs/main/HistoricalNotes/2001-02-13-Reference-Memory.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-02-13-Reference-MemoryResponse.txt (renamed from docs/main/HistoricalNotes/2001-02-13-Reference-MemoryResponse.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-04-16-DynamicCompilation.txt (renamed from docs/main/HistoricalNotes/2001-04-16-DynamicCompilation.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-05-18-ExceptionHandling.txt (renamed from docs/main/HistoricalNotes/2001-05-18-ExceptionHandling.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-05-19-ExceptionResponse.txt (renamed from docs/main/HistoricalNotes/2001-05-19-ExceptionResponse.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-06-01-GCCOptimizations.txt (renamed from docs/main/HistoricalNotes/2001-06-01-GCCOptimizations.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-06-01-GCCOptimizations2.txt (renamed from docs/main/HistoricalNotes/2001-06-01-GCCOptimizations2.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-06-20-.NET-Differences.txt (renamed from docs/main/HistoricalNotes/2001-06-20-.NET-Differences.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-07-06-LoweringIRForCodeGen.txt (renamed from docs/main/HistoricalNotes/2001-07-06-LoweringIRForCodeGen.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-09-18-OptimizeExceptions.txt (renamed from docs/main/HistoricalNotes/2001-09-18-OptimizeExceptions.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2002-05-12-InstListChange.txt (renamed from docs/main/HistoricalNotes/2002-05-12-InstListChange.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2002-06-25-MegaPatchInfo.txt (renamed from docs/main/HistoricalNotes/2002-06-25-MegaPatchInfo.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2003-01-23-CygwinNotes.txt (renamed from docs/main/HistoricalNotes/2003-01-23-CygwinNotes.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2003-06-25-Reoptimizer1.txt (renamed from docs/main/HistoricalNotes/2003-06-25-Reoptimizer1.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2003-06-26-Reoptimizer2.txt (renamed from docs/main/HistoricalNotes/2003-06-26-Reoptimizer2.txt) | 0 | ||||
-rw-r--r-- | docs/HistoricalNotes/2007-OriginalClangReadme.txt (renamed from docs/main/HistoricalNotes/2007-OriginalClangReadme.txt) | 0 | ||||
-rw-r--r-- | docs/HowToReleaseLLVM.html (renamed from docs/main/HowToReleaseLLVM.html) | 0 | ||||
-rw-r--r-- | docs/HowToSubmitABug.html (renamed from docs/main/HowToSubmitABug.html) | 0 | ||||
-rw-r--r-- | docs/LangRef.html (renamed from docs/main/LangRef.html) | 0 | ||||
-rw-r--r-- | docs/Lexicon.html (renamed from docs/main/Lexicon.html) | 0 | ||||
-rw-r--r-- | docs/LinkTimeOptimization.html (renamed from docs/main/LinkTimeOptimization.html) | 0 | ||||
-rw-r--r-- | docs/Makefile | 114 | ||||
-rw-r--r-- | docs/MakefileGuide.html (renamed from docs/main/MakefileGuide.html) | 0 | ||||
-rw-r--r-- | docs/Packaging.html (renamed from docs/main/Packaging.html) | 0 | ||||
-rw-r--r-- | docs/Passes.html (renamed from docs/main/Passes.html) | 0 | ||||
-rw-r--r-- | docs/ProgrammersManual.html (renamed from docs/main/ProgrammersManual.html) | 0 | ||||
-rw-r--r-- | docs/Projects.html (renamed from docs/main/Projects.html) | 0 | ||||
-rw-r--r-- | docs/ReleaseNotes.html (renamed from docs/main/ReleaseNotes.html) | 0 | ||||
-rw-r--r-- | docs/SourceLevelDebugging.html (renamed from docs/main/SourceLevelDebugging.html) | 0 | ||||
-rw-r--r-- | docs/SystemLibrary.html (renamed from docs/main/SystemLibrary.html) | 0 | ||||
-rw-r--r-- | docs/TableGenFundamentals.html (renamed from docs/main/TableGenFundamentals.html) | 0 | ||||
-rw-r--r-- | docs/TestingGuide.html (renamed from docs/main/TestingGuide.html) | 0 | ||||
-rw-r--r-- | docs/UsingLibraries.html (renamed from docs/main/UsingLibraries.html) | 0 | ||||
-rw-r--r-- | docs/WritingAnLLVMBackend.html (renamed from docs/main/WritingAnLLVMBackend.html) | 0 | ||||
-rw-r--r-- | docs/WritingAnLLVMPass.html (renamed from docs/main/WritingAnLLVMPass.html) | 0 | ||||
-rw-r--r-- | docs/api/Makefile | 25 | ||||
-rw-r--r-- | docs/api/api.css | 319 | ||||
-rw-r--r-- | docs/api/footer.html | 14 | ||||
-rw-r--r-- | docs/api/header.html | 13 | ||||
-rw-r--r-- | docs/api/intro.h | 26 | ||||
-rw-r--r-- | docs/api/layout.xml | 184 | ||||
-rw-r--r-- | docs/doxygen.cfg.in (renamed from docs/api/doxygen.cfg.in) | 1408 | ||||
-rw-r--r-- | docs/doxygen.css | 378 | ||||
-rw-r--r-- | docs/doxygen.footer | 13 | ||||
-rw-r--r-- | docs/doxygen.header | 9 | ||||
-rw-r--r-- | docs/doxygen.intro | 18 | ||||
-rw-r--r-- | docs/img/Debugging.gif (renamed from docs/main/img/Debugging.gif) | bin | 20390 -> 20390 bytes | |||
-rw-r--r-- | docs/img/libdeps.gif (renamed from docs/main/img/libdeps.gif) | bin | 52679 -> 52679 bytes | |||
-rw-r--r-- | docs/img/lines.gif (renamed from docs/main/img/lines.gif) | bin | 91 -> 91 bytes | |||
-rw-r--r-- | docs/img/objdeps.gif (renamed from docs/main/img/objdeps.gif) | bin | 16201 -> 16201 bytes | |||
-rw-r--r-- | docs/img/venusflytrap.jpg (renamed from docs/main/img/venusflytrap.jpg) | bin | 56606 -> 56606 bytes | |||
-rw-r--r-- | docs/index.html (renamed from docs/main/index.html) | 38 | ||||
-rw-r--r-- | docs/llvm.css (renamed from docs/main/llvm.css) | 0 | ||||
-rw-r--r-- | docs/main/Makefile | 18 | ||||
-rw-r--r-- | docs/mk/api.mk | 205 | ||||
-rw-r--r-- | docs/mk/common.defs.mk | 119 | ||||
-rw-r--r-- | docs/mk/common.rules.mk | 54 | ||||
-rw-r--r-- | docs/mk/main.mk | 243 | ||||
-rw-r--r-- | docs/re_format.7 (renamed from docs/main/re_format.7) | 0 | ||||
-rw-r--r-- | docs/tutorial/LangImpl1.html (renamed from docs/main/tutorial/LangImpl1.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/LangImpl2.html (renamed from docs/main/tutorial/LangImpl2.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/LangImpl3.html (renamed from docs/main/tutorial/LangImpl3.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/LangImpl4.html (renamed from docs/main/tutorial/LangImpl4.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/LangImpl5-cfg.png (renamed from docs/main/tutorial/LangImpl5-cfg.png) | bin | 38586 -> 38586 bytes | |||
-rw-r--r-- | docs/tutorial/LangImpl5.html (renamed from docs/main/tutorial/LangImpl5.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/LangImpl6.html (renamed from docs/main/tutorial/LangImpl6.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/LangImpl7.html (renamed from docs/main/tutorial/LangImpl7.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/LangImpl8.html (renamed from docs/main/tutorial/LangImpl8.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/Makefile | 28 | ||||
-rw-r--r-- | docs/tutorial/OCamlLangImpl1.html (renamed from docs/main/tutorial/OCamlLangImpl1.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/OCamlLangImpl2.html (renamed from docs/main/tutorial/OCamlLangImpl2.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/OCamlLangImpl3.html (renamed from docs/main/tutorial/OCamlLangImpl3.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/OCamlLangImpl4.html (renamed from docs/main/tutorial/OCamlLangImpl4.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/OCamlLangImpl5.html (renamed from docs/main/tutorial/OCamlLangImpl5.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/OCamlLangImpl6.html (renamed from docs/main/tutorial/OCamlLangImpl6.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/OCamlLangImpl7.html (renamed from docs/main/tutorial/OCamlLangImpl7.html) | 0 | ||||
-rw-r--r-- | docs/tutorial/index.html (renamed from docs/main/tutorial/index.html) | 0 |
136 files changed, 1595 insertions, 2034 deletions
diff --git a/docs/main/AliasAnalysis.html b/docs/AliasAnalysis.html index 5b4eb937a5..5b4eb937a5 100644 --- a/docs/main/AliasAnalysis.html +++ b/docs/AliasAnalysis.html diff --git a/docs/main/BitCodeFormat.html b/docs/BitCodeFormat.html index f1ddefdea9..f1ddefdea9 100644 --- a/docs/main/BitCodeFormat.html +++ b/docs/BitCodeFormat.html diff --git a/docs/main/Bugpoint.html b/docs/Bugpoint.html index bf75b5ba44..bf75b5ba44 100644 --- a/docs/main/Bugpoint.html +++ b/docs/Bugpoint.html diff --git a/docs/main/CFEBuildInstrs.html b/docs/CFEBuildInstrs.html index ed2f295b7a..ed2f295b7a 100644 --- a/docs/main/CFEBuildInstrs.html +++ b/docs/CFEBuildInstrs.html diff --git a/docs/main/CMake.html b/docs/CMake.html index 40a2cec8e9..40a2cec8e9 100644 --- a/docs/main/CMake.html +++ b/docs/CMake.html diff --git a/docs/main/CodeGenerator.html b/docs/CodeGenerator.html index fbdc294e4a..fbdc294e4a 100644 --- a/docs/main/CodeGenerator.html +++ b/docs/CodeGenerator.html diff --git a/docs/main/CodingStandards.html b/docs/CodingStandards.html index 7815e19739..7815e19739 100644 --- a/docs/main/CodingStandards.html +++ b/docs/CodingStandards.html diff --git a/docs/main/CommandGuide/FileCheck.pod b/docs/CommandGuide/FileCheck.pod index 433979a871..433979a871 100644 --- a/docs/main/CommandGuide/FileCheck.pod +++ b/docs/CommandGuide/FileCheck.pod diff --git a/docs/CommandGuide/Makefile b/docs/CommandGuide/Makefile new file mode 100644 index 0000000000..2c2d0760e7 --- /dev/null +++ b/docs/CommandGuide/Makefile @@ -0,0 +1,103 @@ +##===- docs/CommandGuide/Makefile --------------------------*- Makefile -*-===## +# +# The LLVM Compiler Infrastructure +# +# This file is distributed under the University of Illinois Open Source +# License. See LICENSE.TXT for details. +# +##===----------------------------------------------------------------------===## + +ifdef BUILD_FOR_WEBSITE +# This special case is for keeping the CommandGuide on the LLVM web site +# up to date automatically as the documents are checked in. It must build +# the POD files to HTML only and keep them in the src directories. It must also +# build in an unconfigured tree, hence the ifdef. To use this, run +# make -s BUILD_FOR_WEBSITE=1 inside the cvs commit script. +SRC_DOC_DIR= +DST_HTML_DIR=html/ +DST_MAN_DIR=man/man1/ +DST_PS_DIR=ps/ + +# If we are in BUILD_FOR_WEBSITE mode, default to the all target. +all:: html man ps + +clean: + rm -f pod2htm*.*~~ $(HTML) $(MAN) $(PS) + +# To create other directories, as needed, and timestamp their creation +%/.dir: + -mkdir $* > /dev/null + date > $@ + +else + +# Otherwise, if not in BUILD_FOR_WEBSITE mode, use the project info. +LEVEL := ../.. +include $(LEVEL)/Makefile.common + +SRC_DOC_DIR=$(PROJ_SRC_DIR)/ +DST_HTML_DIR=$(PROJ_OBJ_DIR)/ +DST_MAN_DIR=$(PROJ_OBJ_DIR)/ +DST_PS_DIR=$(PROJ_OBJ_DIR)/ + +endif + + +POD := $(wildcard $(SRC_DOC_DIR)*.pod) +HTML := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_HTML_DIR)%.html, $(POD)) +MAN := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_MAN_DIR)%.1, $(POD)) +PS := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_PS_DIR)%.ps, $(POD)) + +# The set of man pages we will not install +NO_INSTALL_MANS = $(DST_MAN_DIR)FileCheck.1 + +# The set of man pages that we will install +INSTALL_MANS = $(filter-out $(NO_INSTALL_MANS), $(MAN)) + +.SUFFIXES: +.SUFFIXES: .html .pod .1 .ps + +$(DST_HTML_DIR)%.html: %.pod $(DST_HTML_DIR)/.dir + pod2html --css=manpage.css --htmlroot=. \ + --podpath=. --noindex --infile=$< --outfile=$@ --title=$* + +$(DST_MAN_DIR)%.1: %.pod $(DST_MAN_DIR)/.dir + pod2man --release=CVS --center="LLVM Command Guide" $< $@ + +$(DST_PS_DIR)%.ps: $(DST_MAN_DIR)%.1 $(DST_PS_DIR)/.dir + groff -Tps -man $< > $@ + + +html: $(HTML) +man: $(MAN) +ps: $(PS) + +EXTRA_DIST := $(POD) index.html + +clean-local:: + $(Verb) $(RM) -f pod2htm*.*~~ $(HTML) $(MAN) $(PS) + +HTML_DIR := $(DESTDIR)$(PROJ_docsdir)/html/CommandGuide +MAN_DIR := $(DESTDIR)$(PROJ_mandir)/man1 +PS_DIR := $(DESTDIR)$(PROJ_docsdir)/ps + +install-local:: $(HTML) $(INSTALL_MANS) $(PS) + $(Echo) Installing HTML CommandGuide Documentation + $(Verb) $(MKDIR) $(HTML_DIR) + $(Verb) $(DataInstall) $(HTML) $(HTML_DIR) + $(Verb) $(DataInstall) $(PROJ_SRC_DIR)/index.html $(HTML_DIR) + $(Verb) $(DataInstall) $(PROJ_SRC_DIR)/manpage.css $(HTML_DIR) + $(Echo) Installing MAN CommandGuide Documentation + $(Verb) $(MKDIR) $(MAN_DIR) + $(Verb) $(DataInstall) $(INSTALL_MANS) $(MAN_DIR) + $(Echo) Installing PS CommandGuide Documentation + $(Verb) $(MKDIR) $(PS_DIR) + $(Verb) $(DataInstall) $(PS) $(PS_DIR) + +uninstall-local:: + $(Echo) Uninstalling CommandGuide Documentation + $(Verb) $(RM) -rf $(HTML_DIR) $(MAN_DIR) $(PS_DIR) + +printvars:: + $(Echo) "POD : " '$(POD)' + $(Echo) "HTML : " '$(HTML)' diff --git a/docs/main/CommandGuide/bugpoint.pod b/docs/CommandGuide/bugpoint.pod index 7afeea1aba..7afeea1aba 100644 --- a/docs/main/CommandGuide/bugpoint.pod +++ b/docs/CommandGuide/bugpoint.pod diff --git a/docs/CommandGuide/html/manpage.css b/docs/CommandGuide/html/manpage.css new file mode 100644 index 0000000000..b200343490 --- /dev/null +++ b/docs/CommandGuide/html/manpage.css @@ -0,0 +1,256 @@ +/* Based on http://www.perldoc.com/css/perldoc.css */ + +@import url("../llvm.css"); + +body { font-family: Arial,Helvetica; } + +blockquote { margin: 10pt; } + +h1, a { color: #336699; } + + +/*** Top menu style ****/ +.mmenuon { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #ff6600; font-size: 10pt; + } +.mmenuoff { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #ffffff; font-size: 10pt; +} +.cpyright { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #ffffff; font-size: xx-small; +} +.cpyrightText { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #ffffff; font-size: xx-small; +} +.sections { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #336699; font-size: 11pt; +} +.dsections { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #336699; font-size: 12pt; +} +.slink { + font-family: Arial,Helvetica; font-weight: normal; text-decoration: none; + color: #000000; font-size: 9pt; +} + +.slink2 { font-family: Arial,Helvetica; text-decoration: none; color: #336699; } + +.maintitle { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #336699; font-size: 18pt; +} +.dblArrow { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #336699; font-size: small; +} +.menuSec { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #336699; font-size: small; +} + +.newstext { + font-family: Arial,Helvetica; font-size: small; +} + +.linkmenu { + font-family: Arial,Helvetica; color: #000000; font-weight: bold; + text-decoration: none; +} + +P { + font-family: Arial,Helvetica; +} + +PRE { + font-size: 10pt; +} +.quote { + font-family: Times; text-decoration: none; + color: #000000; font-size: 9pt; font-style: italic; +} +.smstd { font-family: Arial,Helvetica; color: #000000; font-size: x-small; } +.std { font-family: Arial,Helvetica; color: #000000; } +.meerkatTitle { + font-family: sans-serif; font-size: x-small; color: black; } + +.meerkatDescription { font-family: sans-serif; font-size: 10pt; color: black } +.meerkatCategory { + font-family: sans-serif; font-size: 9pt; font-weight: bold; font-style: italic; + color: brown; } +.meerkatChannel { + font-family: sans-serif; font-size: 9pt; font-style: italic; color: brown; } +.meerkatDate { font-family: sans-serif; font-size: xx-small; color: #336699; } + +.tocTitle { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #333333; font-size: 10pt; +} + +.toc-item { + font-family: Arial,Helvetica; font-weight: bold; + color: #336699; font-size: 10pt; text-decoration: underline; +} + +.perlVersion { + font-family: Arial,Helvetica; font-weight: bold; + color: #336699; font-size: 10pt; text-decoration: none; +} + +.podTitle { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #000000; +} + +.docTitle { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #000000; font-size: 10pt; +} +.dotDot { + font-family: Arial,Helvetica; font-weight: bold; + color: #000000; font-size: 9pt; +} + +.docSec { + font-family: Arial,Helvetica; font-weight: normal; + color: #333333; font-size: 9pt; +} +.docVersion { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #336699; font-size: 10pt; +} + +.docSecs-on { + font-family: Arial,Helvetica; font-weight: normal; text-decoration: none; + color: #ff0000; font-size: 10pt; +} +.docSecs-off { + font-family: Arial,Helvetica; font-weight: normal; text-decoration: none; + color: #333333; font-size: 10pt; +} + +h2 { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #336699; font-size: medium; +} +h1 { + font-family: Verdana,Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #336699; font-size: large; +} + +DL { + font-family: Arial,Helvetica; font-weight: normal; text-decoration: none; + color: #333333; font-size: 10pt; +} + +UL > LI > A { + font-family: Arial,Helvetica; font-weight: bold; + color: #336699; font-size: 10pt; +} + +.moduleInfo { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #333333; font-size: 11pt; +} + +.moduleInfoSec { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #336699; font-size: 10pt; +} + +.moduleInfoVal { + font-family: Arial,Helvetica; font-weight: normal; text-decoration: underline; + color: #000000; font-size: 10pt; +} + +.cpanNavTitle { + font-family: Arial,Helvetica; font-weight: bold; + color: #ffffff; font-size: 10pt; +} +.cpanNavLetter { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #333333; font-size: 9pt; +} +.cpanCat { + font-family: Arial,Helvetica; font-weight: bold; text-decoration: none; + color: #336699; font-size: 9pt; +} + +.bttndrkblue-bkgd-top { + background-color: #225688; + background-image: url(/global/mvc_objects/images/bttndrkblue_bgtop.gif); +} +.bttndrkblue-bkgd-left { + background-color: #225688; + background-image: url(/global/mvc_objects/images/bttndrkblue_bgleft.gif); +} +.bttndrkblue-bkgd { + padding-top: 0px; + padding-bottom: 0px; + margin-bottom: 0px; + margin-top: 0px; + background-repeat: no-repeat; + background-color: #225688; + background-image: url(/global/mvc_objects/images/bttndrkblue_bgmiddle.gif); + vertical-align: top; +} +.bttndrkblue-bkgd-right { + background-color: #225688; + background-image: url(/global/mvc_objects/images/bttndrkblue_bgright.gif); +} +.bttndrkblue-bkgd-bottom { + background-color: #225688; + background-image: url(/global/mvc_objects/images/bttndrkblue_bgbottom.gif); +} +.bttndrkblue-text a { + color: #ffffff; + text-decoration: none; +} +a.bttndrkblue-text:hover { + color: #ffDD3C; + text-decoration: none; +} +.bg-ltblue { + background-color: #f0f5fa; +} + +.border-left-b { + background: #f0f5fa url(/i/corner-leftline.gif) repeat-y; +} + +.border-right-b { + background: #f0f5fa url(/i/corner-rightline.gif) repeat-y; +} + +.border-top-b { + background: #f0f5fa url(/i/corner-topline.gif) repeat-x; +} + +.border-bottom-b { + background: #f0f5fa url(/i/corner-botline.gif) repeat-x; +} + +.border-right-w { + background: #ffffff url(/i/corner-rightline.gif) repeat-y; +} + +.border-top-w { + background: #ffffff url(/i/corner-topline.gif) repeat-x; +} + +.border-bottom-w { + background: #ffffff url(/i/corner-botline.gif) repeat-x; +} + +.bg-white { + background-color: #ffffff; +} + +.border-left-w { + background: #ffffff url(/i/corner-leftline.gif) repeat-y; +} diff --git a/docs/main/CommandGuide/index.html b/docs/CommandGuide/index.html index 7179675943..72cd2cf5f9 100644 --- a/docs/main/CommandGuide/index.html +++ b/docs/CommandGuide/index.html @@ -3,7 +3,7 @@ <html> <head> <title>LLVM Command Guide</title> - <link rel="stylesheet" href="../llvm.css" type="text/css"> + <link rel="stylesheet" href="/docs/llvm.css" type="text/css"> </head> <body> @@ -32,44 +32,44 @@ options) arguments to the tool you are interested in.</p> <ul> -<li><a href="llvm-as.html"><b>llvm-as</b></a> - +<li><a href="/cmds/llvm-as.html"><b>llvm-as</b></a> - assemble a human-readable .ll file into bytecode</li> -<li><a href="llvm-dis.html"><b>llvm-dis</b></a> - +<li><a href="/cmds/llvm-dis.html"><b>llvm-dis</b></a> - disassemble a bytecode file into a human-readable .ll file</li> -<li><a href="opt.html"><b>opt</b></a> - +<li><a href="/cmds/opt.html"><b>opt</b></a> - run a series of LLVM-to-LLVM optimizations on a bytecode file</li> -<li><a href="llc.html"><b>llc</b></a> - +<li><a href="/cmds/llc.html"><b>llc</b></a> - generate native machine code for a bytecode file</li> -<li><a href="lli.html"><b>lli</b></a> - +<li><a href="/cmds/lli.html"><b>lli</b></a> - directly run a program compiled to bytecode using a JIT compiler or interpreter</li> -<li><a href="llvm-link.html"><b>llvm-link</b></a> - +<li><a href="/cmds/llvm-link.html"><b>llvm-link</b></a> - link several bytecode files into one</li> -<li><a href="llvm-ar.html"><b>llvm-ar</b></a> - +<li><a href="/cmds/llvm-ar.html"><b>llvm-ar</b></a> - archive bytecode files</li> -<li><a href="llvm-ranlib.html"><b>llvm-ranlib</b></a> - +<li><a href="/cmds/llvm-ranlib.html"><b>llvm-ranlib</b></a> - create an index for archives made with llvm-ar</li> -<li><a href="llvm-nm.html"><b>llvm-nm</b></a> - +<li><a href="/cmds/llvm-nm.html"><b>llvm-nm</b></a> - print out the names and types of symbols in a bytecode file</li> -<li><a href="llvm-prof.html"><b>llvm-prof</b></a> - +<li><a href="/cmds/llvm-prof.html"><b>llvm-prof</b></a> - format raw `<tt>llvmprof.out</tt>' data into a human-readable report</li> -<li><a href="llvm-ld.html"><b>llvm-ld</b></a> - +<li><a href="/cmds/llvm-ld.html"><b>llvm-ld</b></a> - general purpose linker with loadable runtime optimization support</li> -<li><a href="llvm-config.html"><b>llvm-config</b></a> - +<li><a href="/cmds/llvm-config.html"><b>llvm-config</b></a> - print out LLVM compilation options, libraries, etc. as configured</li> -<li><a href="llvmc.html"><b>llvmc</b></a> - +<li><a href="/cmds/llvmc.html"><b>llvmc</b></a> - a generic customizable compiler driver</li> </ul> @@ -85,10 +85,10 @@ options) arguments to the tool you are interested in.</p> <div class="doc_text"> <ul> -<li><a href="llvmgcc.html"><b>llvm-gcc</b></a> - +<li><a href="/cmds/llvmgcc.html"><b>llvm-gcc</b></a> - GCC-based C front-end for LLVM -<li><a href="llvmgxx.html"><b>llvm-g++</b></a> - +<li><a href="/cmds/llvmgxx.html"><b>llvm-g++</b></a> - GCC-based C++ front-end for LLVM</li> </ul> @@ -106,13 +106,13 @@ options) arguments to the tool you are interested in.</p> <ul> -<li><a href="bugpoint.html"><b>bugpoint</b></a> - +<li><a href="/cmds/bugpoint.html"><b>bugpoint</b></a> - automatic test-case reducer</li> -<li><a href="llvm-extract.html"><b>llvm-extract</b></a> - +<li><a href="/cmds/llvm-extract.html"><b>llvm-extract</b></a> - extract a function from an LLVM bytecode file</li> -<li><a href="llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> - +<li><a href="/cmds/llvm-bcanalyzer.html"><b>llvm-bcanalyzer</b></a> - bytecode analyzer (analyzes the binary encoding itself, not the program it represents)</li> @@ -128,11 +128,11 @@ options) arguments to the tool you are interested in.</p> <div class="doc_text"> <ul> -<li><a href="FileCheck.html"><b>FileCheck</b></a> - +<li><a href="/cmds/FileCheck.html"><b>FileCheck</b></a> - Flexible file verifier used extensively by the testing harness</li> -<li><a href="tblgen.html"><b>tblgen</b></a> - +<li><a href="/cmds/tblgen.html"><b>tblgen</b></a> - target description reader and generator</li> -<li><a href="lit.html"><b>lit</b></a> - +<li><a href="/cmds/lit.html"><b>lit</b></a> - LLVM Integrated Tester, for running tests</li> </ul> diff --git a/docs/main/CommandGuide/lit.pod b/docs/CommandGuide/lit.pod index 72d9d2b394..72d9d2b394 100644 --- a/docs/main/CommandGuide/lit.pod +++ b/docs/CommandGuide/lit.pod diff --git a/docs/main/CommandGuide/llc.pod b/docs/CommandGuide/llc.pod index ac24aab4ff..ac24aab4ff 100644 --- a/docs/main/CommandGuide/llc.pod +++ b/docs/CommandGuide/llc.pod diff --git a/docs/main/CommandGuide/lli.pod b/docs/CommandGuide/lli.pod index d368bec866..d368bec866 100644 --- a/docs/main/CommandGuide/lli.pod +++ b/docs/CommandGuide/lli.pod diff --git a/docs/main/CommandGuide/llvm-ar.pod b/docs/CommandGuide/llvm-ar.pod index 63ba43f6f6..63ba43f6f6 100644 --- a/docs/main/CommandGuide/llvm-ar.pod +++ b/docs/CommandGuide/llvm-ar.pod diff --git a/docs/main/CommandGuide/llvm-as.pod b/docs/CommandGuide/llvm-as.pod index 185c009698..185c009698 100644 --- a/docs/main/CommandGuide/llvm-as.pod +++ b/docs/CommandGuide/llvm-as.pod diff --git a/docs/main/CommandGuide/llvm-bcanalyzer.pod b/docs/CommandGuide/llvm-bcanalyzer.pod index b0bc0cddba..b0bc0cddba 100644 --- a/docs/main/CommandGuide/llvm-bcanalyzer.pod +++ b/docs/CommandGuide/llvm-bcanalyzer.pod diff --git a/docs/main/CommandGuide/llvm-config.pod b/docs/CommandGuide/llvm-config.pod index 4e38dae3df..4e38dae3df 100644 --- a/docs/main/CommandGuide/llvm-config.pod +++ b/docs/CommandGuide/llvm-config.pod diff --git a/docs/main/CommandGuide/llvm-dis.pod b/docs/CommandGuide/llvm-dis.pod index 5b2f4ef4e9..5b2f4ef4e9 100644 --- a/docs/main/CommandGuide/llvm-dis.pod +++ b/docs/CommandGuide/llvm-dis.pod diff --git a/docs/main/CommandGuide/llvm-extract.pod b/docs/CommandGuide/llvm-extract.pod index d4baab7399..d4baab7399 100644 --- a/docs/main/CommandGuide/llvm-extract.pod +++ b/docs/CommandGuide/llvm-extract.pod diff --git a/docs/main/CommandGuide/llvm-ld.pod b/docs/CommandGuide/llvm-ld.pod index 536ab0fa43..536ab0fa43 100644 --- a/docs/main/CommandGuide/llvm-ld.pod +++ b/docs/CommandGuide/llvm-ld.pod diff --git a/docs/main/CommandGuide/llvm-link.pod b/docs/CommandGuide/llvm-link.pod index 8d06cc9d9d..8d06cc9d9d 100644 --- a/docs/main/CommandGuide/llvm-link.pod +++ b/docs/CommandGuide/llvm-link.pod diff --git a/docs/main/CommandGuide/llvm-nm.pod b/docs/CommandGuide/llvm-nm.pod index a580d3f5ca..a580d3f5ca 100644 --- a/docs/main/CommandGuide/llvm-nm.pod +++ b/docs/CommandGuide/llvm-nm.pod diff --git a/docs/main/CommandGuide/llvm-prof.pod b/docs/CommandGuide/llvm-prof.pod index 9541b05dca..9541b05dca 100644 --- a/docs/main/CommandGuide/llvm-prof.pod +++ b/docs/CommandGuide/llvm-prof.pod diff --git a/docs/main/CommandGuide/llvm-ranlib.pod b/docs/CommandGuide/llvm-ranlib.pod index 53cd34bbb5..53cd34bbb5 100644 --- a/docs/main/CommandGuide/llvm-ranlib.pod +++ b/docs/CommandGuide/llvm-ranlib.pod diff --git a/docs/main/CommandGuide/llvmc.pod b/docs/CommandGuide/llvmc.pod index d237ca4c14..d237ca4c14 100644 --- a/docs/main/CommandGuide/llvmc.pod +++ b/docs/CommandGuide/llvmc.pod diff --git a/docs/main/CommandGuide/llvmgcc.pod b/docs/CommandGuide/llvmgcc.pod index 9892ca7186..9892ca7186 100644 --- a/docs/main/CommandGuide/llvmgcc.pod +++ b/docs/CommandGuide/llvmgcc.pod diff --git a/docs/main/CommandGuide/llvmgxx.pod b/docs/CommandGuide/llvmgxx.pod index 64b670ebe0..64b670ebe0 100644 --- a/docs/main/CommandGuide/llvmgxx.pod +++ b/docs/CommandGuide/llvmgxx.pod diff --git a/docs/main/CommandGuide/manpage.css b/docs/CommandGuide/manpage.css index c922564dc3..c922564dc3 100644 --- a/docs/main/CommandGuide/manpage.css +++ b/docs/CommandGuide/manpage.css diff --git a/docs/main/CommandGuide/opt.pod b/docs/CommandGuide/opt.pod index d1d1db5ef6..d1d1db5ef6 100644 --- a/docs/main/CommandGuide/opt.pod +++ b/docs/CommandGuide/opt.pod diff --git a/docs/main/CommandGuide/tblgen.pod b/docs/CommandGuide/tblgen.pod index d127492a91..d127492a91 100644 --- a/docs/main/CommandGuide/tblgen.pod +++ b/docs/CommandGuide/tblgen.pod diff --git a/docs/main/CommandLine.html b/docs/CommandLine.html index 47ab2cc074..47ab2cc074 100644 --- a/docs/main/CommandLine.html +++ b/docs/CommandLine.html diff --git a/docs/main/CompilerDriver.html b/docs/CompilerDriver.html index 3c82e2b076..3c82e2b076 100644 --- a/docs/main/CompilerDriver.html +++ b/docs/CompilerDriver.html diff --git a/docs/main/CompilerDriverTutorial.html b/docs/CompilerDriverTutorial.html index 317b1d1271..317b1d1271 100644 --- a/docs/main/CompilerDriverTutorial.html +++ b/docs/CompilerDriverTutorial.html diff --git a/docs/main/CompilerWriterInfo.html b/docs/CompilerWriterInfo.html index 5d071f7326..5d071f7326 100644 --- a/docs/main/CompilerWriterInfo.html +++ b/docs/CompilerWriterInfo.html diff --git a/docs/main/DebuggingJITedCode.html b/docs/DebuggingJITedCode.html index 92570f454c..92570f454c 100644 --- a/docs/main/DebuggingJITedCode.html +++ b/docs/DebuggingJITedCode.html diff --git a/docs/main/DeveloperPolicy.html b/docs/DeveloperPolicy.html index 357c92956f..357c92956f 100644 --- a/docs/main/DeveloperPolicy.html +++ b/docs/DeveloperPolicy.html diff --git a/docs/main/ExceptionHandling.html b/docs/ExceptionHandling.html index 9c7c615052..9c7c615052 100644 --- a/docs/main/ExceptionHandling.html +++ b/docs/ExceptionHandling.html diff --git a/docs/main/ExtendedIntegerResults.txt b/docs/ExtendedIntegerResults.txt index 44e9fbf0e7..44e9fbf0e7 100644 --- a/docs/main/ExtendedIntegerResults.txt +++ b/docs/ExtendedIntegerResults.txt diff --git a/docs/main/ExtendingLLVM.html b/docs/ExtendingLLVM.html index 647fa01d53..647fa01d53 100644 --- a/docs/main/ExtendingLLVM.html +++ b/docs/ExtendingLLVM.html diff --git a/docs/main/FAQ.html b/docs/FAQ.html index bf050c492e..bf050c492e 100644 --- a/docs/main/FAQ.html +++ b/docs/FAQ.html diff --git a/docs/main/GCCFEBuildInstrs.html b/docs/GCCFEBuildInstrs.html index b675ee76a7..b675ee76a7 100644 --- a/docs/main/GCCFEBuildInstrs.html +++ b/docs/GCCFEBuildInstrs.html diff --git a/docs/main/GarbageCollection.html b/docs/GarbageCollection.html index d0b651eb64..d0b651eb64 100644 --- a/docs/main/GarbageCollection.html +++ b/docs/GarbageCollection.html diff --git a/docs/main/GetElementPtr.html b/docs/GetElementPtr.html index 1bf6f432de..1bf6f432de 100644 --- a/docs/main/GetElementPtr.html +++ b/docs/GetElementPtr.html diff --git a/docs/main/GettingStarted.html b/docs/GettingStarted.html index 8bb1ac41e4..8bb1ac41e4 100644 --- a/docs/main/GettingStarted.html +++ b/docs/GettingStarted.html diff --git a/docs/main/GettingStartedVS.html b/docs/GettingStartedVS.html index 5a86199f7e..5a86199f7e 100644 --- a/docs/main/GettingStartedVS.html +++ b/docs/GettingStartedVS.html diff --git a/docs/main/GoldPlugin.html b/docs/GoldPlugin.html index 66e099bad0..66e099bad0 100644 --- a/docs/main/GoldPlugin.html +++ b/docs/GoldPlugin.html diff --git a/docs/main/HistoricalNotes/2000-11-18-EarlyDesignIdeas.txt b/docs/HistoricalNotes/2000-11-18-EarlyDesignIdeas.txt index f086181192..f086181192 100644 --- a/docs/main/HistoricalNotes/2000-11-18-EarlyDesignIdeas.txt +++ b/docs/HistoricalNotes/2000-11-18-EarlyDesignIdeas.txt diff --git a/docs/main/HistoricalNotes/2000-11-18-EarlyDesignIdeasResp.txt b/docs/HistoricalNotes/2000-11-18-EarlyDesignIdeasResp.txt index 1c725f5aa7..1c725f5aa7 100644 --- a/docs/main/HistoricalNotes/2000-11-18-EarlyDesignIdeasResp.txt +++ b/docs/HistoricalNotes/2000-11-18-EarlyDesignIdeasResp.txt diff --git a/docs/main/HistoricalNotes/2000-12-06-EncodingIdea.txt b/docs/HistoricalNotes/2000-12-06-EncodingIdea.txt index 8c452924dd..8c452924dd 100644 --- a/docs/main/HistoricalNotes/2000-12-06-EncodingIdea.txt +++ b/docs/HistoricalNotes/2000-12-06-EncodingIdea.txt diff --git a/docs/main/HistoricalNotes/2000-12-06-MeetingSummary.txt b/docs/HistoricalNotes/2000-12-06-MeetingSummary.txt index b66e18556f..b66e18556f 100644 --- a/docs/main/HistoricalNotes/2000-12-06-MeetingSummary.txt +++ b/docs/HistoricalNotes/2000-12-06-MeetingSummary.txt diff --git a/docs/main/HistoricalNotes/2001-01-31-UniversalIRIdea.txt b/docs/HistoricalNotes/2001-01-31-UniversalIRIdea.txt index 111706a344..111706a344 100644 --- a/docs/main/HistoricalNotes/2001-01-31-UniversalIRIdea.txt +++ b/docs/HistoricalNotes/2001-01-31-UniversalIRIdea.txt diff --git a/docs/main/HistoricalNotes/2001-02-06-TypeNotationDebate.txt b/docs/HistoricalNotes/2001-02-06-TypeNotationDebate.txt index c09cf1f03c..c09cf1f03c 100644 --- a/docs/main/HistoricalNotes/2001-02-06-TypeNotationDebate.txt +++ b/docs/HistoricalNotes/2001-02-06-TypeNotationDebate.txt diff --git a/docs/main/HistoricalNotes/2001-02-06-TypeNotationDebateResp1.txt b/docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp1.txt index 8bfefbf69f..8bfefbf69f 100644 --- a/docs/main/HistoricalNotes/2001-02-06-TypeNotationDebateResp1.txt +++ b/docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp1.txt diff --git a/docs/main/HistoricalNotes/2001-02-06-TypeNotationDebateResp2.txt b/docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp2.txt index 6e9784158a..6e9784158a 100644 --- a/docs/main/HistoricalNotes/2001-02-06-TypeNotationDebateResp2.txt +++ b/docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp2.txt diff --git a/docs/main/HistoricalNotes/2001-02-06-TypeNotationDebateResp4.txt b/docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp4.txt index 7b9032742a..7b9032742a 100644 --- a/docs/main/HistoricalNotes/2001-02-06-TypeNotationDebateResp4.txt +++ b/docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp4.txt diff --git a/docs/main/HistoricalNotes/2001-02-09-AdveComments.txt b/docs/HistoricalNotes/2001-02-09-AdveComments.txt index 5503233c1e..5503233c1e 100644 --- a/docs/main/HistoricalNotes/2001-02-09-AdveComments.txt +++ b/docs/HistoricalNotes/2001-02-09-AdveComments.txt diff --git a/docs/main/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt b/docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt index 5c87330fb7..5c87330fb7 100644 --- a/docs/main/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt +++ b/docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt diff --git a/docs/main/HistoricalNotes/2001-02-13-Reference-Memory.txt b/docs/HistoricalNotes/2001-02-13-Reference-Memory.txt index 2c7534d9da..2c7534d9da 100644 --- a/docs/main/HistoricalNotes/2001-02-13-Reference-Memory.txt +++ b/docs/HistoricalNotes/2001-02-13-Reference-Memory.txt diff --git a/docs/main/HistoricalNotes/2001-02-13-Reference-MemoryResponse.txt b/docs/HistoricalNotes/2001-02-13-Reference-MemoryResponse.txt index 505343378d..505343378d 100644 --- a/docs/main/HistoricalNotes/2001-02-13-Reference-MemoryResponse.txt +++ b/docs/HistoricalNotes/2001-02-13-Reference-MemoryResponse.txt diff --git a/docs/main/HistoricalNotes/2001-04-16-DynamicCompilation.txt b/docs/HistoricalNotes/2001-04-16-DynamicCompilation.txt index 5f7843ab56..5f7843ab56 100644 --- a/docs/main/HistoricalNotes/2001-04-16-DynamicCompilation.txt +++ b/docs/HistoricalNotes/2001-04-16-DynamicCompilation.txt diff --git a/docs/main/HistoricalNotes/2001-05-18-ExceptionHandling.txt b/docs/HistoricalNotes/2001-05-18-ExceptionHandling.txt index b546301d35..b546301d35 100644 --- a/docs/main/HistoricalNotes/2001-05-18-ExceptionHandling.txt +++ b/docs/HistoricalNotes/2001-05-18-ExceptionHandling.txt diff --git a/docs/main/HistoricalNotes/2001-05-19-ExceptionResponse.txt b/docs/HistoricalNotes/2001-05-19-ExceptionResponse.txt index 3375365f54..3375365f54 100644 --- a/docs/main/HistoricalNotes/2001-05-19-ExceptionResponse.txt +++ b/docs/HistoricalNotes/2001-05-19-ExceptionResponse.txt diff --git a/docs/main/HistoricalNotes/2001-06-01-GCCOptimizations.txt b/docs/HistoricalNotes/2001-06-01-GCCOptimizations.txt index 97af16a2da..97af16a2da 100644 --- a/docs/main/HistoricalNotes/2001-06-01-GCCOptimizations.txt +++ b/docs/HistoricalNotes/2001-06-01-GCCOptimizations.txt diff --git a/docs/main/HistoricalNotes/2001-06-01-GCCOptimizations2.txt b/docs/HistoricalNotes/2001-06-01-GCCOptimizations2.txt index 6c9e0971a0..6c9e0971a0 100644 --- a/docs/main/HistoricalNotes/2001-06-01-GCCOptimizations2.txt +++ b/docs/HistoricalNotes/2001-06-01-GCCOptimizations2.txt diff --git a/docs/main/HistoricalNotes/2001-06-20-.NET-Differences.txt b/docs/HistoricalNotes/2001-06-20-.NET-Differences.txt index 1bc2eae746..1bc2eae746 100644 --- a/docs/main/HistoricalNotes/2001-06-20-.NET-Differences.txt +++ b/docs/HistoricalNotes/2001-06-20-.NET-Differences.txt diff --git a/docs/main/HistoricalNotes/2001-07-06-LoweringIRForCodeGen.txt b/docs/HistoricalNotes/2001-07-06-LoweringIRForCodeGen.txt index 3e10416fe6..3e10416fe6 100644 --- a/docs/main/HistoricalNotes/2001-07-06-LoweringIRForCodeGen.txt +++ b/docs/HistoricalNotes/2001-07-06-LoweringIRForCodeGen.txt diff --git a/docs/main/HistoricalNotes/2001-09-18-OptimizeExceptions.txt b/docs/HistoricalNotes/2001-09-18-OptimizeExceptions.txt index 9379081018..9379081018 100644 --- a/docs/main/HistoricalNotes/2001-09-18-OptimizeExceptions.txt +++ b/docs/HistoricalNotes/2001-09-18-OptimizeExceptions.txt diff --git a/docs/main/HistoricalNotes/2002-05-12-InstListChange.txt b/docs/HistoricalNotes/2002-05-12-InstListChange.txt index 004edb068d..004edb068d 100644 --- a/docs/main/HistoricalNotes/2002-05-12-InstListChange.txt +++ b/docs/HistoricalNotes/2002-05-12-InstListChange.txt diff --git a/docs/main/HistoricalNotes/2002-06-25-MegaPatchInfo.txt b/docs/HistoricalNotes/2002-06-25-MegaPatchInfo.txt index 2ca46117ca..2ca46117ca 100644 --- a/docs/main/HistoricalNotes/2002-06-25-MegaPatchInfo.txt +++ b/docs/HistoricalNotes/2002-06-25-MegaPatchInfo.txt diff --git a/docs/main/HistoricalNotes/2003-01-23-CygwinNotes.txt b/docs/HistoricalNotes/2003-01-23-CygwinNotes.txt index fbe811d627..fbe811d627 100644 --- a/docs/main/HistoricalNotes/2003-01-23-CygwinNotes.txt +++ b/docs/HistoricalNotes/2003-01-23-CygwinNotes.txt diff --git a/docs/main/HistoricalNotes/2003-06-25-Reoptimizer1.txt b/docs/HistoricalNotes/2003-06-25-Reoptimizer1.txt index a745784639..a745784639 100644 --- a/docs/main/HistoricalNotes/2003-06-25-Reoptimizer1.txt +++ b/docs/HistoricalNotes/2003-06-25-Reoptimizer1.txt diff --git a/docs/main/HistoricalNotes/2003-06-26-Reoptimizer2.txt b/docs/HistoricalNotes/2003-06-26-Reoptimizer2.txt index ec4b93fea0..ec4b93fea0 100644 --- a/docs/main/HistoricalNotes/2003-06-26-Reoptimizer2.txt +++ b/docs/HistoricalNotes/2003-06-26-Reoptimizer2.txt diff --git a/docs/main/HistoricalNotes/2007-OriginalClangReadme.txt b/docs/HistoricalNotes/2007-OriginalClangReadme.txt index 611dc9d2c0..611dc9d2c0 100644 --- a/docs/main/HistoricalNotes/2007-OriginalClangReadme.txt +++ b/docs/HistoricalNotes/2007-OriginalClangReadme.txt diff --git a/docs/main/HowToReleaseLLVM.html b/docs/HowToReleaseLLVM.html index c0ad6c9381..c0ad6c9381 100644 --- a/docs/main/HowToReleaseLLVM.html +++ b/docs/HowToReleaseLLVM.html diff --git a/docs/main/HowToSubmitABug.html b/docs/HowToSubmitABug.html index 90efbe321b..90efbe321b 100644 --- a/docs/main/HowToSubmitABug.html +++ b/docs/HowToSubmitABug.html diff --git a/docs/main/LangRef.html b/docs/LangRef.html index 5a73f6afd8..5a73f6afd8 100644 --- a/docs/main/LangRef.html +++ b/docs/LangRef.html diff --git a/docs/main/Lexicon.html b/docs/Lexicon.html index 82a58aa148..82a58aa148 100644 --- a/docs/main/Lexicon.html +++ b/docs/Lexicon.html diff --git a/docs/main/LinkTimeOptimization.html b/docs/LinkTimeOptimization.html index 1433d082ae..1433d082ae 100644 --- a/docs/main/LinkTimeOptimization.html +++ b/docs/LinkTimeOptimization.html diff --git a/docs/Makefile b/docs/Makefile index a0fdfe31e0..8f7d6171d3 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -7,7 +7,117 @@ # ##===----------------------------------------------------------------------===## -LEVEL = .. -DIRS = main api +LEVEL := .. +DIRS := CommandGuide tutorial + +ifdef BUILD_FOR_WEBSITE +PROJ_OBJ_DIR = . +DOXYGEN = doxygen + +$(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in + cat $< | sed \ + -e 's/@abs_top_srcdir@/../g' \ + -e 's/@DOT@/dot/g' \ + -e 's/@PACKAGE_VERSION@/mainline/' \ + -e 's/@abs_top_builddir@/../g' > $@ +endif include $(LEVEL)/Makefile.common + +HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \ + $(wildcard $(PROJ_SRC_DIR)/*.css) +IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*) +DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \ + doxygen.intro +EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img + +.PHONY: install-html install-doxygen doxygen install-ocamldoc ocamldoc generated + +install_targets := install-html +ifeq ($(ENABLE_DOXYGEN),1) +install_targets += install-doxygen +endif +ifneq (,$(filter ocaml,$(BINDINGS_TO_BUILD))) +install_targets += install-ocamldoc +endif +install-local:: $(install_targets) + +# Live documentation is generated for the web site using this target: +# 'make generated BUILD_FOR_WEBSITE=1' +generated:: doxygen ocamldoc + +install-html: $(PROJ_OBJ_DIR)/html.tar.gz + $(Echo) Installing HTML documentation + $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html + $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html/img + $(Verb) $(DataInstall) $(HTML) $(DESTDIR)$(PROJ_docsdir)/html + $(Verb) $(DataInstall) $(IMAGES) $(DESTDIR)$(PROJ_docsdir)/html/img + $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(DESTDIR)$(PROJ_docsdir) + +$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML) + $(Echo) Packaging HTML documentation + $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar + $(Verb) cd $(PROJ_SRC_DIR) && \ + $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html + $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar + +install-doxygen: doxygen + $(Echo) Installing doxygen documentation + $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html/doxygen + $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(DESTDIR)$(PROJ_docsdir) + $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \ + $(FIND) . -type f -exec \ + $(DataInstall) {} $(DESTDIR)$(PROJ_docsdir)/html/doxygen \; + +doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz + +regendoc: + $(Echo) Building doxygen documentation + $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \ + $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \ + fi + $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg + +$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg + $(Echo) Packaging doxygen documentation + $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar + $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen + $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar + $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/ + +userloc: $(LLVM_SRC_ROOT)/docs/userloc.html + +$(LLVM_SRC_ROOT)/docs/userloc.html: + $(Echo) Making User LOC Table + $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \ + -html lib include tools runtime utils examples autoconf test > docs/userloc.html + +install-ocamldoc: ocamldoc + $(Echo) Installing ocamldoc documentation + $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/ocamldoc/html + $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(DESTDIR)$(PROJ_docsdir) + $(Verb) cd $(PROJ_OBJ_DIR)/ocamldoc && \ + $(FIND) . -type f -exec \ + $(DataInstall) {} $(DESTDIR)$(PROJ_docsdir)/ocamldoc/html \; + +ocamldoc: regen-ocamldoc + $(Echo) Packaging ocamldoc documentation + $(Verb) $(RM) -rf $(PROJ_OBJ_DIR)/ocamldoc.tar* + $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/ocamldoc.tar ocamldoc + $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/ocamldoc.tar + $(Verb) $(CP) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(PROJ_OBJ_DIR)/ocamldoc/html/ + +regen-ocamldoc: + $(Echo) Building ocamldoc documentation + $(Verb) if test -e $(PROJ_OBJ_DIR)/ocamldoc ; then \ + $(RM) -rf $(PROJ_OBJ_DIR)/ocamldoc ; \ + fi + $(Verb) $(MAKE) -C $(LEVEL)/bindings/ocaml ocamldoc + $(Verb) $(MKDIR) $(PROJ_OBJ_DIR)/ocamldoc/html + $(Verb) \ + $(OCAMLDOC) -d $(PROJ_OBJ_DIR)/ocamldoc/html -sort -colorize-code -html \ + `$(FIND) $(LEVEL)/bindings/ocaml -name "*.odoc" -exec echo -load '{}' ';'` + +uninstall-local:: + $(Echo) Uninstalling Documentation + $(Verb) $(RM) -rf $(DESTDIR)$(PROJ_docsdir) diff --git a/docs/main/MakefileGuide.html b/docs/MakefileGuide.html index b1f8292831..b1f8292831 100644 --- a/docs/main/MakefileGuide.html +++ b/docs/MakefileGuide.html diff --git a/docs/main/Packaging.html b/docs/Packaging.html index 217590e6c2..217590e6c2 100644 --- a/docs/main/Packaging.html +++ b/docs/Packaging.html diff --git a/docs/main/Passes.html b/docs/Passes.html index 0f8f69e5ab..0f8f69e5ab 100644 --- a/docs/main/Passes.html +++ b/docs/Passes.html diff --git a/docs/main/ProgrammersManual.html b/docs/ProgrammersManual.html index 46fd33f40d..46fd33f40d 100644 --- a/docs/main/ProgrammersManual.html +++ b/docs/ProgrammersManual.html diff --git a/docs/main/Projects.html b/docs/Projects.html index ada6196be2..ada6196be2 100644 --- a/docs/main/Projects.html +++ b/docs/Projects.html diff --git a/docs/main/ReleaseNotes.html b/docs/ReleaseNotes.html index 94e5c7b398..94e5c7b398 100644 --- a/docs/main/ReleaseNotes.html +++ b/docs/ReleaseNotes.html diff --git a/docs/main/SourceLevelDebugging.html b/docs/SourceLevelDebugging.html index e4c8460610..e4c8460610 100644 --- a/docs/main/SourceLevelDebugging.html +++ b/docs/SourceLevelDebugging.html diff --git a/docs/main/SystemLibrary.html b/docs/SystemLibrary.html index 0289a55410..0289a55410 100644 --- a/docs/main/SystemLibrary.html +++ b/docs/SystemLibrary.html diff --git a/docs/main/TableGenFundamentals.html b/docs/TableGenFundamentals.html index 5be11624ce..5be11624ce 100644 --- a/docs/main/TableGenFundamentals.html +++ b/docs/TableGenFundamentals.html diff --git a/docs/main/TestingGuide.html b/docs/TestingGuide.html index c39065a282..c39065a282 100644 --- a/docs/main/TestingGuide.html +++ b/docs/TestingGuide.html diff --git a/docs/main/UsingLibraries.html b/docs/UsingLibraries.html index b1a3b4de62..b1a3b4de62 100644 --- a/docs/main/UsingLibraries.html +++ b/docs/UsingLibraries.html diff --git a/docs/main/WritingAnLLVMBackend.html b/docs/WritingAnLLVMBackend.html index f49875c204..f49875c204 100644 --- a/docs/main/WritingAnLLVMBackend.html +++ b/docs/WritingAnLLVMBackend.html diff --git a/docs/main/WritingAnLLVMPass.html b/docs/WritingAnLLVMPass.html index f3e791f094..f3e791f094 100644 --- a/docs/main/WritingAnLLVMPass.html +++ b/docs/WritingAnLLVMPass.html diff --git a/docs/api/Makefile b/docs/api/Makefile deleted file mode 100644 index dd9f7fc9dd..0000000000 --- a/docs/api/Makefile +++ /dev/null @@ -1,25 +0,0 @@ -##===- docs/api/Makefile -----------------------------------*- Makefile -*-===## -# -# The LLVM Compiler Infrastructure -# -# This file is distributed under the University of Illinois Open Source -# License. See LICENSE.TXT for details. -# -##===----------------------------------------------------------------------===## - -LEVEL = ../.. - -include $(LEVEL)/Makefile.common - -API.Project = LLVM -API.project = llvm -API.srcdir = $(PROJ_SRC_ROOT) - -include $(LLVM_SRC_ROOT)/docs/mk/api.mk - -# Define API.skeleton=1 to generate only a subset of API; for testing purposes. -# -ifneq (undefined,$(origin API.skeleton)) -$(API.doxygen.target): API.doxygen.cfg.opts += INPUT=$(PROJ_SRC_DIR)/intro.h -$(API.doxygen.target): API.doxygen.cfg.opts += INPUT+=$(PROJ_SRC_ROOT)/include/llvm/Target -endif diff --git a/docs/api/api.css b/docs/api/api.css deleted file mode 100644 index bcc485368b..0000000000 --- a/docs/api/api.css +++ /dev/null @@ -1,319 +0,0 @@ -* { - margin: 0px; - padding: 0px; -} - -body { - padding: 1.0em 2.0em; -} - -body, table { - font-family: Arial, Helvetica, sans-serif; - font-size: 13px; - background-color: #FFFFFF; - color: #000000; -} - -a { - color: #3C7AA0; - text-decoration: none; - font-weight: bold; -} -a:hover { - color: #53A9E8; -} -a.anchor { - color: #000000; -} - -h1 { - font-size: 200%; - text-align: center; -} -h2 { - font-size: 140%; -} -h3 { - font-size: 120%; -} - -h2, h3 { - border-bottom: 2px solid; - margin-top: 2em; -} - -h1, h2, h3 { - margin-bottom: 0.5em; -} - -h3.version { - border: none; - margin-top: 0; - text-align: center; -} - -hr { - display: none; -} - -div.header { -} -div.header div.title { - text-align: center; - font-size: xx-large; - font-weight: bold; -} - -div.footer { - padding-top: 2em; -} -div.footer div { - padding-top: 0.5em; - border-top: 2px solid #000000; -} -div.footer div p { - text-align: right; - font-size: x-small; -} - -div.navigation { - font-size: 9pt; -} -div.navigation div.tabs { - padding-top: 0.5em; - padding-bottom: 0.5em; - border-bottom: 2px solid #000000; -} -div.navigation div.tabs ul { -} -div.navigation div.tabs ul li { - display: inline; - line-height: 200%; -} -div.navigation div.tabs ul li a { - background-color: #183F66; - color: #EEEEEE; - border: 1px solid gray; - border: none; - padding: 0.25em 1.0em; -} -div.navigation div.tabs ul li a { - background: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#3C7AA0), to(#183F66)); - background: -moz-linear-gradient(top, #3C7AA0, #183F66); - -webkit-border-radius: 1.0em; - -moz-border-radius: 1.0em; - -webkit-box-shadow: 0px 1px 2px #777777; - -moz-box-shadow: #777777 0px 1px 2px; -} -div.navigation div.tabs ul li a:hover { - background-color: #2E76CF; - background: -webkit-gradient(linear, 0% 0%, 0% 100%, from(#53A9E8), to(#2E76CF)); - background: -moz-linear-gradient(top, #53A9E8, #2E76CF); - text-shadow: 0px 0px 2px #2F2F2F; -} -div.navigation div.tabs ul li.current a { - color: #F0A000; -} -div.navigation div.tabs ul li.current a:hover { -} - -div.navigation div.navpath { - padding-top: 0.5em; - padding-bottom: 0.5em; - padding-left: 1.0em; - border-bottom: 2px solid #000000; -} - -div.contents { - padding: 1.0em 0.0em; -} - -div.contents p { - margin: 1em 0em; -} - -div.contents dl, -div.contents ul { - margin-top: 1em; - margin-bottom: 1em; - padding-left: 2.0em; - list-style-type: none; -} - -div.contents dl ul, -div.contents ul ul { - margin-top: 0em; - margin-bottom: 0em; -} - -div.center { - text-align:center; -} - -div.dynheader { - padding-top: 1.0em; - padding-bottom: 1.0em; -} - -table { - table-layout: auto; - border-spacing: 0; - border-collapse: collapse; - margin-top: 1.0em; - border-bottom: 1px solid #999999; -} - -table h2 { - border-top: 1px solid #999999; - border-bottom: none; - padding: 0.2em 8px; - margin: 0; - background: #181E29; - color: #FFFFFF; - text-shadow: 0px 0px 2px #000000; - background: -webkit-gradient(linear, 0% 0%, 100% 0%, from(#181E29), to(#868CA8)); - background: -moz-linear-gradient(left, #181E29, #868CA8); -} - -td.indexkey, td.indexvalue { - background-color: #F0F1F2; - border: 1px solid; - padding: 0.4em 0.5em; -} - -td.memTemplParams, td.memItemLeft, td.memItemRight { - border-top: 1px solid #999999; -} -td.memTemplParams, td.memTemplItemLeft, td.memTemplItemRight, td.memItemLeft, td.memItemRight, td.mdescLeft, td.mdescRight { - background-color: #F0F1F2; -} -td.memItemLeft, td.mdescLeft { - padding-left: 0.5em; - padding-left: 0.2em; - border-right: 1px solid #dddddd; -} -td.memItemRight, td.mdescRight { - padding-right: 0.5em; - padding-left: 0.2em; -} - -td div.groupHeader { - border-top: 1px solid #999999; - padding: 0.2em 8px; -} - -td.memItemLeft, td.memItemRight, -td.mdescLeft, td.mdescRight { - padding-top: 0.2em; - padding-bottom: 0.2em; -} - -tr.memlist { - background-color: #F0F1F2; -} -tr.memlist td { - border: 1px solid #999999; - padding: 0.2em 0.5em; -} - -div.memitem { - border: 1px solid #999999; - margin-top: 1.0em; - margin-bottom: 1.0em; - -webkit-border-radius: 0.5em; - -webkit-box-shadow: 3px 3px 6px #777777; - -moz-border-radius: 0.5em; - -moz-box-shadow: black 3px 3px 3px; -} -div.memitem div.memproto { - background-color: #E3E4E5; - padding: 0.25em 0.5em; - -webkit-border-top-left-radius: 0.5em; - -webkit-border-top-right-radius: 0.5em; - -moz-border-radius-topleft: 0.5em; - -moz-border-radius-topright: 0.5em; -} -div.memitem div.memproto td code { - color: #AA0000; -} -div.memitem div.memproto td.paramname code { - color: #000000; -} -div.memitem div.memdoc { - background-color: #F0F1F2; - padding: 0.25em 0.5em; - -webkit-border-bottom-left-radius: 0.5em; - -webkit-border-bottom-right-radius: 0.5em; - -moz-border-radius-bottomleft: 0.5em; - -moz-border-radius-bottomright: 0.5em; -} -div.memitem div.memdoc table { - background-color: #F0F1F2; - border: none; -} - -table.memname { - border: none; - background-color: #E3E4E5; - margin: 0; - padding: 0; -} -td.paramtype { - padding-left: 0.5em; -} -td.paramname { - padding-right: 0.5em; -} - -pre.fragment { - background-color: #F5F5F5; - border: 1px solid #999999; - margin: 1em; - padding: 0.5em; - font-family: monospace, fixed; - font-size: 8pt; - overflow: auto; - word-wrap: break-word; -} -pre.fragment span.keyword { - color: #008000 -} -pre.fragment span.keywordtype { - color: #604020 -} -pre.fragment span.keywordflow { - color: #e08000 -} -pre.fragment span.comment { - color: #800000 -} -pre.fragment span.preprocessor { - color: #806020 -} -pre.fragment span.stringliteral { - color: #002080 -} -pre.fragment span.charliteral { - color: #008080 -} -pre.fragment span.vhdldigit { - color: #ff00ff -} -pre.fragment span.vhdlchar { - color: #000000 -} -pre.fragment span.vhdlkeyword { - color: #700070 -} -pre.fragment span.vhdllogic { - color: #ff0000 -} - -div.contents div.intro div.logo { - background: -webkit-gradient(radial, 50% 50%, 0, 50% 50%, 400, from(#F0A000), to(rgba(24,63,102,0.8))); - background: -moz-radial-gradient(50% 50%, farthest-side, #F0A000, rgba(24,63,102,0.8)); -} - -div.contents div.dynheader { - padding: 0.25em 0.0em; -} diff --git a/docs/api/footer.html b/docs/api/footer.html deleted file mode 100644 index 93f2d835fe..0000000000 --- a/docs/api/footer.html +++ /dev/null @@ -1,14 +0,0 @@ -<div class="footer"> -<div> -<p> - generated on $datetime for <a href="http://llvm.org">$projectname $projectnumber</a> - by <a href="http://www.doxygen.org">Doxygen $doxygenversion</a> -</p> -<p> - Copyright © 2003-2010 University of Illinois at Urbana-Champaign. - All Rights Reserved. -</p> -</div> -</div> -</body> -</html> diff --git a/docs/api/header.html b/docs/api/header.html deleted file mode 100644 index 58bf07e0a5..0000000000 --- a/docs/api/header.html +++ /dev/null @@ -1,13 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> - <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> - <meta name="keywords" content="LLVM,Low Level Virtual Machine,C++,doxygen,API,documentation"/> - <meta name="description" content="C++ source code API documentation for the Low Level Virtual Machine (LLVM)."/> - <title>$title</title> - <link href="$relpath$api.css" rel="stylesheet" type="text/css"/> - <!--[if IE]><link href="$relpath$api.ie.css" rel="stylesheet" type="text/css"/><![endif]--> -</head> -<body> -<div class="header"> -</div> diff --git a/docs/api/intro.h b/docs/api/intro.h deleted file mode 100644 index d3e78e435d..0000000000 --- a/docs/api/intro.h +++ /dev/null @@ -1,26 +0,0 @@ -/** @mainpage LLVM API Documentation -<div class="intro"> -<div class="logo"> - <img src="http://llvm.org/img/DragonMedium.png" - alg="medium dragon logo" width="400" height="400"> -</div> - -@section main_intro Introduction -Welcome to the Low Level Virtual Machine (LLVM). - -<br> -This documentation describes the @b internal software that makes -up LLVM, not the @b external use of LLVM. There are no instructions -here on how to use LLVM, only the APIs that make up the software. For usage -instructions, please see the programmer's guide or reference manual. - -@section main_caveat Caveat -This documentation is generated directly from the source code with doxygen. -Since LLVM is constantly under active development, what you're about to -read is out of date! However, it may still be useful since certain portions -of LLVM are very stable. - -@section main_changelog Change Log -- Original content written 12/30/2003 by Reid Spencer -</div> -*/ diff --git a/docs/api/layout.xml b/docs/api/layout.xml deleted file mode 100644 index b8df0aa911..0000000000 --- a/docs/api/layout.xml +++ /dev/null @@ -1,184 +0,0 @@ -<doxygenlayout version="1.0"> - <!-- Navigation index tabs for HTML output --> - <navindex> - <tab type="mainpage" visible="yes" title=""/> - <tab type="namespaces" visible="yes" title=""> - <tab type="namespaces" visible="yes" title=""/> - <tab type="namespacemembers" visible="yes" title=""/> - </tab> - <tab type="classes" visible="yes" title=""> - <tab type="classes" visible="yes" title=""/> - <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> - <tab type="hierarchy" visible="yes" title=""/> - <tab type="classmembers" visible="yes" title=""/> - </tab> - <tab type="modules" visible="yes" title=""/> - <tab type="files" visible="yes" title=""> - <tab type="files" visible="yes" title=""/> - <tab type="globals" visible="yes" title=""/> - </tab> - <tab type="dirs" visible="yes" title=""/> - <tab type="examples" visible="yes" title=""/> - <tab type="pages" visible="yes" title=""/> - </navindex> - - <!-- Layout definition for a class page --> - <class> - <briefdescription visible="yes"/> - <includes visible="$SHOW_INCLUDE_FILES"/> - <inheritancegraph visible="$CLASS_GRAPH"/> - <collaborationgraph visible="$COLLABORATION_GRAPH"/> - <allmemberslink visible="yes"/> - <memberdecl> - <nestedclasses visible="yes" title=""/> - <publictypes title=""/> - <publicslots title=""/> - <signals title=""/> - <publicmethods title=""/> - <publicstaticmethods title=""/> - <publicattributes title=""/> - <publicstaticattributes title=""/> - <protectedtypes title=""/> - <protectedslots title=""/> - <protectedmethods title=""/> - <protectedstaticmethods title=""/> - <protectedattributes title=""/> - <protectedstaticattributes title=""/> - <packagetypes title=""/> - <packagemethods title=""/> - <packagestaticmethods title=""/> - <packageattributes title=""/> - <packagestaticattributes title=""/> - <properties title=""/> - <events title=""/> - <privatetypes title=""/> - <privateslots title=""/> - <privatemethods title=""/> - <privatestaticmethods title=""/> - <privateattributes title=""/> - <privatestaticattributes title=""/> - <friends title=""/> - <related title="" subtitle=""/> - <membergroups visible="yes"/> - </memberdecl> - <detaileddescription title=""/> - <memberdef> - <typedefs title=""/> - <enums title=""/> - <constructors title=""/> - <functions title=""/> - <related title=""/> - <variables title=""/> - <properties title=""/> - <events title=""/> - </memberdef> - <usedfiles visible="$SHOW_USED_FILES"/> - <authorsection visible="yes"/> - </class> - - <!-- Layout definition for a namespace page --> - <namespace> - <briefdescription visible="yes"/> - <memberdecl> - <nestednamespaces visible="yes" title=""/> - <classes visible="yes" title=""/> - <typedefs title=""/> - <enums title=""/> - <functions title=""/> - <variables title=""/> - <membergroups visible="yes"/> - </memberdecl> - <detaileddescription title=""/> - <memberdef> - <typedefs title=""/> - <enums title=""/> - <functions title=""/> - <variables title=""/> - </memberdef> - <authorsection visible="yes"/> - </namespace> - - <!-- Layout definition for a file page --> - <file> - <briefdescription visible="yes"/> - <includes visible="$SHOW_INCLUDE_FILES"/> - <includegraph visible="$INCLUDE_GRAPH"/> - <includedbygraph visible="$INCLUDED_BY_GRAPH"/> - <sourcelink visible="yes"/> - <memberdecl> - <classes visible="yes" title=""/> - <namespaces visible="yes" title=""/> - <defines title=""/> - <typedefs title=""/> - <enums title=""/> - <functions title=""/> - <variables title=""/> - <membergroups visible="yes"/> - </memberdecl> - <detaileddescription title=""/> - <memberdef> - <defines title=""/> - <typedefs title=""/> - <enums title=""/> - <functions title=""/> - <variables title=""/> - </memberdef> - <authorsection/> - </file> - - <!-- Layout definition for a group page --> - <group> - <briefdescription visible="yes"/> - <groupgraph visible="$GROUP_GRAPHS"/> - <memberdecl> - <classes visible="yes" title=""/> - <namespaces visible="yes" title=""/> - <dirs visible="yes" title=""/> - <nestedgroups visible="yes" title=""/> - <files visible="yes" title=""/> - <defines title=""/> - <typedefs title=""/> - <enums title=""/> - <enumvalues title=""/> - <functions title=""/> - <variables title=""/> - <signals title=""/> - <publicslots title=""/> - <protectedslots title=""/> - <privateslots title=""/> - <events title=""/> - <properties title=""/> - <friends title=""/> - <membergroups visible="yes"/> - </memberdecl> - <detaileddescription title=""/> - <memberdef> - <pagedocs/> - <defines title=""/> - <typedefs title=""/> - <enums title=""/> - <enumvalues title=""/> - <functions title=""/> - <variables title=""/> - <signals title=""/> - <publicslots title=""/> - <protectedslots title=""/> - <privateslots title=""/> - <events title=""/> - <properties title=""/> - <friends title=""/> - </memberdef> - <authorsection visible="yes"/> - </group> - - <!-- Layout definition for a directory page --> - <directory> - <briefdescription visible="yes"/> - <directorygraph visible="yes"/> - <memberdecl> - <dirs visible="yes"/> - <files visible="yes"/> - </memberdecl> - <detaileddescription title=""/> - </directory> -</doxygenlayout> diff --git a/docs/api/doxygen.cfg.in b/docs/doxygen.cfg.in index 21cadfe8f0..45b8f42e5d 100644 --- a/docs/api/doxygen.cfg.in +++ b/docs/doxygen.cfg.in @@ -1,4 +1,4 @@ -# Doxyfile 1.6.2 +# Doxyfile 1.5.6 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project @@ -11,218 +11,214 @@ # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- -# Project related configuration options +# Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = LLVM -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = @version@ +PROJECT_NUMBER = @PACKAGE_VERSION@ -# 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 +# 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 = @output_dir@ +OUTPUT_DIRECTORY = @abs_top_builddir@/docs/doxygen -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" -ABBREVIATE_BRIEF = +ABBREVIATE_BRIEF = -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. -FULL_PATH_NAMES = YES +FULL_PATH_NAMES = NO -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the # path to strip. -STRIP_FROM_PATH = @srcdir@ +STRIP_FROM_PATH = ../.. -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO -# 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 regular Qt-style comments +# 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 regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = NO -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it +# 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 + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 2 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = +ALIASES = -# 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 +# 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 = NO -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO -# Doxygen selects the parser to use depending on the extension of the files it parses. -# With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this tag. -# The format is ext=language, where ext is a file extension, and language is one of -# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, -# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat -# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = NO @@ -232,453 +228,414 @@ BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen to replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penality. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will rougly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols - -SYMBOL_CACHE_SIZE = 0 - #--------------------------------------------------------------------------- # 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 +# 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 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file +# 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 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 -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default # anonymous namespace are hidden. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in # declaration order. -SORT_BRIEF_DOCS = YES - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. - -SORT_MEMBERS_CTORS_1ST = YES +SORT_BRIEF_DOCS = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the +# Note: This option applies only to the class list, not to the # alphabetical list. -SORT_BY_SCOPE_NAME = YES +SORT_BY_SCOPE_NAME = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. SHOW_DIRECTORIES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the +# This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = YES -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command <command> <input-file>, where <command> is the value of -# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file -# provided by doxygen. Whatever the program writes to standard output +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by -# doxygen. The layout file controls the global structure of the generated output files -# in an output format independent way. The create the layout file that represents -# doxygen's defaults, run doxygen with the -l option. You can optionally specify a -# file name after the option, if omitted DoxygenLayout.xml will be used as the name -# of the layout file. - -LAYOUT_FILE = @srcdir@/docs/api/layout.xml +FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. -QUIET = YES +QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = NO -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = NO -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. -WARN_IF_DOC_ERROR = NO +WARN_IF_DOC_ERROR = YES -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = NO -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) -WARN_FORMAT = "$file:$line: $text" +WARN_FORMAT = -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written # to stderr. -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # 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 +# 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 = @srcdir@/include \ - @srcdir@/lib \ - @srcdir@/docs/api/intro.h +INPUT = @abs_top_srcdir@/include \ + @abs_top_srcdir@/lib \ + @abs_top_srcdir@/docs/doxygen.intro -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = +FILE_PATTERNS = -# 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. +# 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 -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* -EXCLUDE_PATTERNS = */.svn +EXCLUDE_PATTERNS = -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = @srcdir@/examples +EXAMPLE_PATH = @abs_top_srcdir@/examples -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left # blank all files are included. -EXAMPLE_PATTERNS = +EXAMPLE_PATTERNS = -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = YES -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = @abs_top_srcdir@/docs/img -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command <filter> <input-file>, where <filter> -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. -# If FILTER_PATTERNS is specified, this tag will be +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be # ignored. -INPUT_FILTER = +INPUT_FILTER = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. -FILTER_PATTERNS = +FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO @@ -687,32 +644,32 @@ FILTER_SOURCE_FILES = NO # 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 +# 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 -# Setting the INLINE_SOURCES tag to YES will include the body +# Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = NO -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = YES @@ -720,21 +677,20 @@ REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. +# link to the source code. Otherwise they will link to the documentstion. REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES @@ -743,21 +699,21 @@ VERBATIM_HEADERS = YES # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = YES -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 4 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = llvm:: @@ -766,113 +722,106 @@ IGNORE_PREFIX = llvm:: # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. -HTML_OUTPUT = html/api +HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = @srcdir@/docs/api/header.html +HTML_HEADER = @abs_top_srcdir@/docs/doxygen.header -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = @srcdir@/docs/api/footer.html +HTML_FOOTER = @abs_top_srcdir@/docs/doxygen.footer -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = NO +HTML_STYLESHEET = @abs_top_srcdir@/docs/doxygen.css -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. HTML_ALIGN_MEMBERS = YES -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. -HTML_DYNAMIC_SECTIONS = NO +GENERATE_HTMLHELP = NO -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). -GENERATE_HTMLHELP = NO +HTML_DYNAMIC_SECTIONS = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be # written to the html output directory. -CHM_FILE = +CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. -HHC_LOCATION = +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO @@ -881,286 +830,203 @@ GENERATE_CHI = NO # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. -CHM_INDEX_ENCODING = +CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members +# The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER -# are set, an additional index file will be generated that can be used as input for -# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated -# HTML documentation. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders - -QHP_VIRTUAL_FOLDER = doc - -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. -# For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see -# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's -# filter section matches. -# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. - -QHP_SECT_FILTER_ATTRS = - -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO -# This tag can be used to set the number of enum values (range [1..20]) +# This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hiererachy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. GENERATE_TREEVIEW = NO -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = NO - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup -# and does not have live searching capabilities. - -SERVER_BASED_SEARCH = NO - #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. -LATEX_OUTPUT = latex +LATEX_OUTPUT = -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. LATEX_CMD_NAME = latex -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. -PAPER_TYPE = a4wide +PAPER_TYPE = letter -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. -EXTRA_PACKAGES = +EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! -LATEX_HEADER = +LATEX_HEADER = -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. -PDF_HYPERLINKS = YES +PDF_HYPERLINKS = NO -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. -USE_PDFLATEX = YES +USE_PDFLATEX = NO -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO -# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. - -LATEX_SOURCE_CODE = NO - #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. -RTF_OUTPUT = rtf +RTF_OUTPUT = -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. -RTF_STYLESHEET_FILE = +RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. -MAN_OUTPUT = man +MAN_OUTPUT = -# The MAN_EXTENSION tag determines the extension that is added to +# The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) -MAN_EXTENSION = .3 +MAN_EXTENSION = -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO @@ -1169,33 +1035,33 @@ MAN_LINKS = NO # configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_SCHEMA = +XML_SCHEMA = -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_DTD = +XML_DTD = -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES @@ -1204,10 +1070,10 @@ XML_PROGRAMLISTING = YES # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO @@ -1216,338 +1082,338 @@ GENERATE_AUTOGEN_DEF = NO # configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. -# This is useful -# if you want to understand what is going on. -# On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = NO -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by # the preprocessor. -INCLUDE_PATH = +INCLUDE_PATH = ../include -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. -INCLUDE_FILE_PATTERNS = +INCLUDE_FILE_PATTERNS = -# 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 +# 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 = +PREDEFINED = -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen +# If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = +GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = YES -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES -# The PERL_PATH should be the absolute path and name of the perl script +# The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). -PERL_PATH = /usr/bin/perl +PERL_PATH = #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. -MSCGEN_PATH = +MSCGEN_PATH = -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = NO -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = YES -# By default doxygen will write a font called FreeSans.ttf to the output -# directory and reference it in all dot files that doxygen generates. This -# font does not include all possible unicode characters however, so when you need -# these (or just want a differently looking font) you can specify the font name -# using DOT_FONTNAME. You need need to make sure dot is able to find the font, -# which can be done by putting it in a standard location or by setting the -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. DOT_FONTNAME = FreeSans -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. -# The default size is 10pt. - -DOT_FONTSIZE = 9 - -# By default doxygen will tell dot to use the output directory to look for the -# FreeSans.ttf font (which doxygen will put there itself). If you specify a -# different font using DOT_FONTNAME you can set the path where dot +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot # can find it using this tag. -DOT_FONTPATH = +DOT_FONTPATH = -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. -COLLABORATION_GRAPH = NO +COLLABORATION_GRAPH = YES -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO -# If set to YES, the inheritance and collaboration graphs will show the +# If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = YES -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. -DOT_PATH = @dot@ +DOT_PATH = @DOT@ -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the # \dotfile command). -DOTFILE_DIRS = +DOTFILE_DIRS = -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of -# a graph (i.e. they become hard to read). +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is enabled by default, which results in a transparent +# background. Warning: Depending on the platform used, enabling this option +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they +# become hard to read). DOT_TRANSPARENT = YES -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. -DOT_MULTI_TARGETS = YES +DOT_MULTI_TARGETS = NO -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/docs/doxygen.css b/docs/doxygen.css new file mode 100644 index 0000000000..83b049b5f1 --- /dev/null +++ b/docs/doxygen.css @@ -0,0 +1,378 @@ +BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { + font-family: Verdana,Geneva,Arial,Helvetica,sans-serif; +} +BODY,TD { + font-size: 90%; +} +H1 { + text-align: center; + font-size: 140%; + font-weight: bold; +} +H2 { + font-size: 120%; + font-style: italic; +} +H3 { + font-size: 100%; +} +CAPTION { font-weight: bold } +DIV.qindex { + width: 100%; + background-color: #eeeeff; + border: 1px solid #b0b0b0; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.nav { + width: 100%; + background-color: #eeeeff; + border: 1px solid #b0b0b0; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navtab { + background-color: #eeeeff; + border: 1px solid #b0b0b0; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +TD.navtab { + font-size: 70%; +} +A.qindex { + text-decoration: none; + font-weight: bold; + color: #1A419D; +} +A.qindex:visited { + text-decoration: none; + font-weight: bold; + color: #1A419D +} +A.qindex:hover { + text-decoration: none; + background-color: #ddddff; +} +A.qindexHL { + text-decoration: none; + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} +A.qindexHL:hover { + text-decoration: none; + background-color: #6666cc; + color: #ffffff; +} +A.qindexHL:visited { + text-decoration: none; background-color: #6666cc; color: #ffffff } +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code:link { text-decoration: none; font-weight: normal; color: #0000FF} +A.code:visited { text-decoration: none; font-weight: normal; color: #0000FF} +A.codeRef:link { font-weight: normal; color: #0000FF} +A.codeRef:visited { font-weight: normal; color: #0000FF} +A:hover { text-decoration: none; background-color: #f2f2ff } +DL.el { margin-left: -1cm } +.fragment { + font-family: Fixed, monospace; + font-size: 95%; +} +PRE.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + margin-top: 4px; + margin-bottom: 4px; + margin-left: 2px; + margin-right: 8px; + padding-left: 6px; + padding-right: 6px; + padding-top: 4px; + padding-bottom: 4px; +} +DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: #F4F4FB; font-weight: bold; } +TD.mdPrefix { + background-color: #F4F4FB; + color: #606060; + font-size: 80%; +} +TD.mdname1 { background-color: #F4F4FB; font-weight: bold; color: #602020; } +TD.mdname { background-color: #F4F4FB; font-weight: bold; color: #602020; width: 600px; } +DIV.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} +DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% } +BODY { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} +TD.indexkey { + background-color: #eeeeff; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TD.indexvalue { + background-color: #eeeeff; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TR.memlist { + background-color: #f0f0f0; +} +P.formulaDsp { text-align: center; } +IMG.formulaDsp { } +IMG.formulaInl { vertical-align: middle; } +SPAN.keyword { color: #008000 } +SPAN.keywordtype { color: #604020 } +SPAN.keywordflow { color: #e08000 } +SPAN.comment { color: #800000 } +SPAN.preprocessor { color: #806020 } +SPAN.stringliteral { color: #002080 } +SPAN.charliteral { color: #008080 } +.mdTable { + border: 1px solid #868686; + background-color: #F4F4FB; +} +.mdRow { + padding: 8px 10px; +} +.mdescLeft { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.mdescRight { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.memItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplParams { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + color: #606060; + background-color: #FAFAFA; + font-size: 80%; +} +.search { color: #003399; + font-weight: bold; +} +FORM.search { + margin-bottom: 0px; + margin-top: 0px; +} +INPUT.search { font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #eeeeff; +} +TD.tiny { font-size: 75%; +} +a { + color: #252E78; +} +a:visited { + color: #3D2185; +} +.dirtab { padding: 4px; + border-collapse: collapse; + border: 1px solid #b0b0b0; +} +TH.dirtab { background: #eeeeff; + font-weight: bold; +} +HR { height: 1px; + border: none; + border-top: 1px solid black; +} + +/* + * LLVM Modifications. + * Note: Everything above here is generated with "doxygen -w htlm" command. See + * "doxygen --help" for details. What follows are CSS overrides for LLVM + * specific formatting. We want to keep the above so it can be replaced with + * subsequent doxygen upgrades. + */ + +.footer { + font-size: 80%; + font-weight: bold; + text-align: center; + vertical-align: middle; +} +.title { + font-size: 25pt; + color: black; background: url("../img/lines.gif"); + font-weight: bold; + border-width: 1px; + border-style: solid none solid none; + text-align: center; + vertical-align: middle; + padding-left: 8pt; + padding-top: 1px; + padding-bottom: 2px +} +A:link { + cursor: pointer; + text-decoration: none; + font-weight: bolder; +} +A:visited { + cursor: pointer; + text-decoration: underline; + font-weight: bolder; +} +A:hover { + cursor: pointer; + text-decoration: underline; + font-weight: bolder; +} +A:active { + cursor: pointer; + text-decoration: underline; + font-weight: bolder; + font-style: italic; +} +H1 { + text-align: center; + font-size: 140%; + font-weight: bold; +} +H2 { + font-size: 120%; + font-style: italic; +} +H3 { + font-size: 100%; +} +A.qindex {} +A.qindexRef {} +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } diff --git a/docs/doxygen.footer b/docs/doxygen.footer new file mode 100644 index 0000000000..d75fff5e4c --- /dev/null +++ b/docs/doxygen.footer @@ -0,0 +1,13 @@ +<hr> +<p class="footer"> +Generated on $datetime for <a href="http://llvm.org">$projectname</a> by +<a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen" +align="middle" border="0"/>$doxygenversion</a><br> +Copyright © 2003-2009 University of Illinois at Urbana-Champaign. +All Rights Reserved.</p> + +<hr> +<!--#include virtual="/attrib.incl" --> + +</body> +</html> diff --git a/docs/doxygen.header b/docs/doxygen.header new file mode 100644 index 0000000000..a520434d6c --- /dev/null +++ b/docs/doxygen.header @@ -0,0 +1,9 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/> +<meta name="keywords" content="LLVM,Low Level Virtual Machine,C++,doxygen,API,documentation"/> +<meta name="description" content="C++ source code API documentation for the Low Level Virtual Machine (LLVM)."/> +<title>LLVM: $title</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"/> +</head><body> +<p class="title">LLVM API Documentation</p> diff --git a/docs/doxygen.intro b/docs/doxygen.intro new file mode 100644 index 0000000000..547730cba7 --- /dev/null +++ b/docs/doxygen.intro @@ -0,0 +1,18 @@ +/// @mainpage Low Level Virtual Machine +/// +/// @section main_intro Introduction +/// Welcome to the Low Level Virtual Machine (LLVM). +/// +/// This documentation describes the @b internal software that makes +/// up LLVM, not the @b external use of LLVM. There are no instructions +/// here on how to use LLVM, only the APIs that make up the software. For usage +/// instructions, please see the programmer's guide or reference manual. +/// +/// @section main_caveat Caveat +/// This documentation is generated directly from the source code with doxygen. +/// Since LLVM is constantly under active development, what you're about to +/// read is out of date! However, it may still be useful since certain portions +/// of LLVM are very stable. +/// +/// @section main_changelog Change Log +/// - Original content written 12/30/2003 by Reid Spencer diff --git a/docs/main/img/Debugging.gif b/docs/img/Debugging.gif Binary files differindex 662d35a673..662d35a673 100644 --- a/docs/main/img/Debugging.gif +++ b/docs/img/Debugging.gif diff --git a/docs/main/img/libdeps.gif b/docs/img/libdeps.gif Binary files differindex c5c0ed4c40..c5c0ed4c40 100644 --- a/docs/main/img/libdeps.gif +++ b/docs/img/libdeps.gif diff --git a/docs/main/img/lines.gif b/docs/img/lines.gif Binary files differindex 88f491edc3..88f491edc3 100644 --- a/docs/main/img/lines.gif +++ b/docs/img/lines.gif diff --git a/docs/main/img/objdeps.gif b/docs/img/objdeps.gif Binary files differindex 57c3e2e60d..57c3e2e60d 100644 --- a/docs/main/img/objdeps.gif +++ b/docs/img/objdeps.gif diff --git a/docs/main/img/venusflytrap.jpg b/docs/img/venusflytrap.jpg Binary files differindex 59340ef3ee..59340ef3ee 100644 --- a/docs/main/img/venusflytrap.jpg +++ b/docs/img/venusflytrap.jpg diff --git a/docs/main/index.html b/docs/index.html index f501267645..bf12f719b2 100644 --- a/docs/main/index.html +++ b/docs/index.html @@ -70,31 +70,31 @@ some tools.</li> Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for those using Visual Studio on Windows.</li> -<li><a href="tutorial/index.html">LLVM Tutorial</a> - A walk through the process of using +<li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li> <li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's policy towards developers and their contributions.</li> -<li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference +<li><a href="/docs/CommandGuide/index.html">LLVM Command Guide</a> - A reference manual for the LLVM command line utilities ("man" pages for LLVM tools).<br> Current tools: - <a href="CommandGuide/llvm-ar.html">llvm-ar</a>, - <a href="CommandGuide/llvm-as.html">llvm-as</a>, - <a href="CommandGuide/llvm-dis.html">llvm-dis</a>, - <a href="CommandGuide/llvm-extract.html">llvm-extract</a>, - <a href="CommandGuide/llvm-ld.html">llvm-ld</a>, - <a href="CommandGuide/llvm-link.html">llvm-link</a>, - <a href="CommandGuide/llvm-nm.html">llvm-nm</a>, - <a href="CommandGuide/llvm-prof.html">llvm-prof</a>, - <a href="CommandGuide/llvm-ranlib.html">llvm-ranlib</a>, - <a href="CommandGuide/opt.html">opt</a>, - <a href="CommandGuide/llc.html">llc</a>, - <a href="CommandGuide/lli.html">lli</a>, - <a href="CommandGuide/llvmc.html">llvmc</a> - <a href="CommandGuide/llvmgcc.html">llvm-gcc</a>, - <a href="CommandGuide/llvmgxx.html">llvm-g++</a>, - <a href="CommandGuide/bugpoint.html">bugpoint</a>, - <a href="CommandGuide/llvm-bcanalyzer.html">llvm-bcanalyzer</a>, + <a href="/cmds/llvm-ar.html">llvm-ar</a>, + <a href="/cmds/llvm-as.html">llvm-as</a>, + <a href="/cmds/llvm-dis.html">llvm-dis</a>, + <a href="/cmds/llvm-extract.html">llvm-extract</a>, + <a href="/cmds/llvm-ld.html">llvm-ld</a>, + <a href="/cmds/llvm-link.html">llvm-link</a>, + <a href="/cmds/llvm-nm.html">llvm-nm</a>, + <a href="/cmds/llvm-prof.html">llvm-prof</a>, + <a href="/cmds/llvm-ranlib.html">llvm-ranlib</a>, + <a href="/cmds/opt.html">opt</a>, + <a href="/cmds/llc.html">llc</a>, + <a href="/cmds/lli.html">lli</a>, + <a href="/cmds/llvmc.html">llvmc</a> + <a href="/cmds/llvmgcc.html">llvm-gcc</a>, + <a href="/cmds/llvmgxx.html">llvm-g++</a>, + <a href="/cmds/bugpoint.html">bugpoint</a>, + <a href="/cmds/llvm-bcanalyzer.html">llvm-bcanalyzer</a>, </li> <li><a href="Passes.html">LLVM's Analysis and Transform Passes</a> - A list of diff --git a/docs/main/llvm.css b/docs/llvm.css index f572b5e571..f572b5e571 100644 --- a/docs/main/llvm.css +++ b/docs/llvm.css diff --git a/docs/main/Makefile b/docs/main/Makefile deleted file mode 100644 index 3d1f16a858..0000000000 --- a/docs/main/Makefile +++ /dev/null @@ -1,18 +0,0 @@ -##===- docs/main/Makefile ----------------------------------*- Makefile -*-===## -# -# The LLVM Compiler Infrastructure -# -# This file is distributed under the University of Illinois Open Source -# License. See LICENSE.TXT for details. -# -##===----------------------------------------------------------------------===## - -LEVEL = ../.. - -include $(LEVEL)/Makefile.common - -MAIN.Project = LLVM -MAIN.project = llvm -MAIN.man.center = LLVM Command Guide - -include $(LLVM_SRC_ROOT)/docs/mk/main.mk diff --git a/docs/mk/api.mk b/docs/mk/api.mk deleted file mode 100644 index 74cd2db456..0000000000 --- a/docs/mk/api.mk +++ /dev/null @@ -1,205 +0,0 @@ -##===- docs/mk/api.mk --------------------------------------*- Makefile -*-===## -# -# The LLVM Compiler Infrastructure -# -# This file is distributed under the University of Illinois Open Source -# License. See LICENSE.TXT for details. -# -##===----------------------------------------------------------------------===## -# -# Generated API documentation support module. -# -# The following variables must be defined before including this makefile: -# -# API.Project formal project name. eg. LLVM or Clang. -# API.project filesystem project name. eg. llvm or clang. -# API.srcdir top-most source dir used in doxygen .cfg file. -# -##===----------------------------------------------------------------------===## - -include $(LLVM_SRC_ROOT)/docs/mk/common.defs.mk - -API.in/ = $(PROJ_SRC_DIR)/ -API.out/ = ./ - -API.html/ = $(API.out/)html/api/ -API.html.tar = $(API.out/)html-api.tar.gz - -API.doxygen = $(DOXYGEN) -API.doxygen.target = $(API.html/)index.html -API.doxygen.extradeps = $(foreach x,html xml h,$(wildcard $(API.in/)*.$(x))) -API.doxygen.cfg = $(API.out/)doxygen.cfg -API.doxygen.cfg.srcdir = $(API.srcdir) -API.doxygen.cfg.objdir = . -API.doxygen.cfg.output_dir = $(API.out/) -API.doxygen.cfg.dot = # blank and doxygen will search path for 'dot' -API.doxygen.cfg.opts = $(call SELECT,API.doxygen.cfg.opts,$(HOST_OS)) -API.doxygen.cfg.opts.__.Darwin = DOT_FONTNAME=Monaco DOT_FONTSIZE=8 -API.doxygen.cfg.opts.__.Linux = DOT_FONTNAME=FreeSans DOT_FONTSIZE=9 -API.doxygen.cfg.opts.__.default = # values from file -API.doxygen.cfg.version = $(call fn.SVN.LCREV,$(API.srcdir)) - -API.doxygen.css = $(API.html/)api.css \ - $(API.html/)api.ie.css - -ifdef VERBOSE -API.doxygen.cfg.opts := QUIET=NO WARN_IF_DOC_ERROR=YES $(API.doxygen.cfg.opts) -endif - -API.files += $(API.html.tar) -API.files += $(API.doxygen.cfg) -API.files += $(API.doxygen.css) -API.files += $(API.doxygen.target) - -DOCS.mkdir.files += $(API.files) - -##===----------------------------------------------------------------------===## - -INSTALL.out/ = $(PROJ_prefix)/share/ -INSTALL.doc/ = $(INSTALL.out/)doc/$(API.project)/ - -INSTALL.html/ = $(INSTALL.doc/)html/api/ -INSTALL.html.target = $(API.doxygen.target:$(API.html/)%=$(INSTALL.html/)%) -INSTALL.html.tar = $(INSTALL.doc/)$(notdir $(API.html.tar)) - -INSTALL.files += $(INSTALL.html.tar) - -DOCS.mkdir.files += $(INSTALL.doc/)file-placebo -DOCS.mkdir.files += $(INSTALL.files) - -##===----------------------------------------------------------------------===## - -clean-local:: - -$(Verb) $(RM) -f $(API.files) - -$(Verb) $(call fn.RMRF,$(API.html/)) - -ifeq ($(ENABLE_DOXYGEN),1) -all:: docs docs-tar -install-local:: install-docs -uninstall-local:: uninstall-docs -endif - -##===----------------------------------------------------------------------===## - -.PHONY: docs-tar -docs-tar: $(API.html.tar) - -.PHONY: docs -docs: $(API.doxygen.target) - -$(API.html.tar): | $(dir $(API.html.tar)) -$(API.html.tar): $(API.doxygen.target) - $(Echo) Creating $(API.Project) API documentation tarball - $(Verb) (set -e; cd $(API.out/); \ - $(TAR) cf - --exclude='*.md5' --exclude='*.map' html/api) \ - $(call fn.PIPE.COMP,$@) > $@ - -$(API.doxygen.cfg): | $(dir $(API.doxygen.cfg)) -$(API.doxygen.cfg): $(notdir $(API.doxygen.cfg)).in - $(Echo) Generating $(API.Project) doxygen config - $(Verb) $(CAT) $< | $(SED) \ - -e 's,@srcdir@,$(API.doxygen.cfg.srcdir),g' \ - -e 's,@objdir@,$(API.doxygen.cfg.objdir),g' \ - -e 's,@output_dir@,$(API.doxygen.cfg.output_dir),g' \ - -e 's,@dot@,$(API.doxygen.cfg.dot),g' \ - -e 's,@version@,$(API.doxygen.cfg.version),g' \ - > $@ - -$(API.html/)api.css: | $(dir $(API.html/)api.css) -$(API.html/)api.css: api.css - $(Echo) Copying $(API.Project) doxygen stylesheet - $(Verb) $(CP) $< $@ - -# IE misbehaves when browser-specific constructs are used. -# This target strips them out to create an IE-specific css file. -# The following is an example of setting background to an extension. -# With IE instead of skipping an unrecognized extension it resets -# the background: -# -# background: -webkit-gradient(...) -# -# Note this simple approach assumes source has strippable single-lines. -# -$(API.html/)api.ie.css: | $(dir $(API.html/)api.ie.css) -$(API.html/)api.ie.css: api.css - $(Echo) Generating $(API.Project) doxygen stylesheet for IE - $(Verb) $(CAT) $< | egrep -v -e '-(moz|webkit)' > $@ - -# Generate API docs. -# -# Define API.nodot=1 to not use 'dot' tool even if available. -# In this mode doxygen has built-in support to generate only class-diagrams -# and thus all other diagrams are skipped. Shaves 80% off generate time. -# -# We pipe (doxygen.cfg + overrides) to doxygen. This allows us to override -# almost any setting in doxygen.cfg file without having to edit it. -# -ifneq (undefined,$(origin API.nodot)) -$(API.doxygen.target): API.doxygen.cfg.opts += HAVE_DOT=NO -$(API.doxygen.target): API.doxygen.target.msg = " (FAST)" -endif -$(API.doxygen.target): | $(dir $(API.doxygen.target)) -$(API.doxygen.target): $(API.doxygen.cfg) -$(API.doxygen.target): $(API.doxygen.css) -$(API.doxygen.target): $(API.doxygen.extradeps) - $(Echo) Generating $(API.Project) API documentation$(API.doxygen.target.msg) - $(Verb) ($(CAT) $(API.doxygen.cfg)$(foreach n,$(API.doxygen.cfg.opts),; echo '$n')) | \ - $(API.doxygen) - - -##===----------------------------------------------------------------------===## - -.PHONY: install-docs -install-docs: $(INSTALL.html.tar) -install-docs: $(INSTALL.html.target) - -$(INSTALL.html.target): | $(INSTALL.doc/) -$(INSTALL.html.target): $(API.html.tar) - $(Echo) Installing $(API.Project) API documentation - $(Verb) $(CAT) $(API.html.tar) $(call fn.PIPE.DECOMP,$(API.html.tar)) | \ - (set -e; cd $(INSTALL.doc/); $(TAR) xf -) - @touch $@ - -$(INSTALL.html.tar): | $(dir $(INSTALL.html.tar)) -$(INSTALL.html.tar): $(API.html.tar) - $(Echo) Installing $(API.Project) API documentation tarball - $(Verb) $(DataInstall) $< $@ - -uninstall-docs: - $(Echo) Uninstalling $(API.Project) API documentation - -$(Verb) $(RM) -f $(INSTALL.files) - -$(Verb) $(call fn.RMRF,$(INSTALL.html/)) - -##===----------------------------------------------------------------------===## - -DOCS.vars.mandatory += API.Project API.project API.srcdir -DOCS.vars.print += $(sort $(filter INSTALL.%/,$(.VARIABLES))) - -HELP.sections += API.help - -define API.help - API Documentation Module. This module is srcdir/objdir build-friendly. - - WARNING: The following directories are recursively deleted during cleanup - procedures. Be sure not to mix files therein or bad things will happen. - - $(API.html/) - $(INSTALL.html/) - - ------------------------------------------------------------------------------ - TARGET NOTES - ------------------------------------------------------------------------------ - *all invokes target docs - *install invokes target install-docs - *uninstall invokes target uninstall-docs - ------------------------------------------------------------------------------ - docs generate API docs from sources using doxygen - ------------------------------------------------------------------------------ - docs-tar create docs tarball $(API.html.tar) - clean remove built files - install-docs install to $(INSTALL.doc/) - uninstall-docs remove installed files - ------------------------------------------------------------------------------ - (targets marked with '*' require configure --enable-doxygen) -endef - -include $(LLVM_SRC_ROOT)/docs/mk/common.rules.mk diff --git a/docs/mk/common.defs.mk b/docs/mk/common.defs.mk deleted file mode 100644 index 5e57e24842..0000000000 --- a/docs/mk/common.defs.mk +++ /dev/null @@ -1,119 +0,0 @@ -##===- docs/mk/common.defs.mk ------------------------------*- Makefile -*-===## -# -# The LLVM Compiler Infrastructure -# -# This file is distributed under the University of Illinois Open Source -# License. See LICENSE.TXT for details. -# -##===----------------------------------------------------------------------===## - -# support for printing errors, warnings and info. - -# FUNCTION: print error message once and dump makefile list. -# $1: error message. do NOT end in punctuation. -# $2: optional. one or more words to list. if words > 1 then 1 per line. -define fn.DUMP.error -$(if $(filter 0,$(words $2)) \ - ,$(error $(call _DUMP.error,$1.)) \ - ,$(if $(filter 1,$(words $2)) \ - ,$(error $(call _DUMP.error,$1: $2)) \ - ,$(error $(call _DUMP.errorm,$1:,$2)))) -endef - -# FUNCTION: print one error message per word and dump makefile list. -# $1: error message. do NOT end in punctuation. -# $2: one or more words to list. 1 word per line. -define fn.DUMP.errorn -$(error $(call _DUMP.errorn,$1,$2)) -endef - -##===----------------------------------------------------------------------===## - -# MAKEFILE PRIVATE. -# support for special makefile printing. Whitespace is very important for all -# definitions; modify with caution. - -define _DUMP.error -ERROR. -*** -*** $1 -*** -$(call _DUMP.makefile_list,***,$1) ERROR -endef - -define _DUMP.errorm -ERROR. -*** -*** $1 -***$(subst *** ,***,$(foreach n,$2, $n$(_TEXT.blank)***)) -$(call _DUMP.makefile_list,***,$1) ERROR -endef - -define _DUMP.errorn -ERROR. -*** -***$(subst *** ,***,$(foreach n,$2, ERROR: $1: $n$(_TEXT.blank)***)) -$(call _DUMP.makefile_list,***,$1) ERROR -endef - -define _DUMP.makefile_list -$1 MAKEFILE_LIST: -$1 $(abspath $(word 1,$(MAKEFILE_LIST))) -$1$(subst $()$1 ,$1,$(foreach n,$(wordlist 2,999,$(MAKEFILE_LIST)), $n$(_TEXT.blank)$1)) -$1 -endef - -# force linefeed. -define _TEXT.blank - - -endef - -##===----------------------------------------------------------------------===## - -# FUNCTION: select -# $1: variable basename (before .__.) -# $2: selection key -# RESULT: variable selection by key -# -SELECT = $(if $($1.__.$2),$($1.__.$2),$($1.__.default)) - -# FUNCTION: safe(r) rm -rf -# $1: list of dirs to remove, recursively -# -# Extra safety is put in place by wrapping dirs in $(realpath) which both cleans -# up the path and returns blank if the path does not exist. -# -# An error is produced if removal of any generally unsafe dirs is attempted. -# -fn.RMRF = $(if $(call _RMRF.eval,$1) \ - ,$(call fn.DUMP.errorn,unsafe recursive dir removal in call function fn.RMRF,$(call _RMRF.eval,$1)) \ - ,$(RM) -rf $(realpath $1)) - -_RMRF.eval = $(sort $(realpath $(filter $(realpath $(_RMRF.never)),$(realpath $1)))) - -_RMRF.never = / /bin /dev /etc /home /net /opt /sbin /tmp /usr /var \ - /usr/bin /usr/sbin /usr/share \ - /usr/local/bin /usr/local/sbin /usr/local/share - -# FUNCTION: pipe and compress. -# $1: target filename with filename extension of compression, if any. -# RESULT: a suitable pipe for compression or empty. -# -fn.PIPE.COMP = $(fn.PIPE.COMP.$(suffix $1)) -fn.PIPE.COMP..gz = | $(GZIP) -fn.PIPE.COMP..bz2 = | $(BZIP2) - -# FUNCTION: pipe and decompress. -# $1: target filename with filename extension of compression, if any. -# RESULT: a suitable pipe for decompression or empty. -# -fn.PIPE.DECOMP = $(fn.PIPE.DECOMP.$(suffix $1)) -fn.PIPE.DECOMP..gz = | $(GZIP) -d -fn.PIPE.DECOMP..bz2 = | $(BZIP2) -d - -# FUNCTION: fetch working copy 'Last Changed Rev'. -# $1: working copy directory. -# RESULT: 'Last Changed Rev' value from svn info. -# -fn.SVN.LCREV = $(shell (svn info $1 2>/dev/null || echo "Last Changed Rev: 0") | $(SED) -n 's/^Last Changed Rev: *\([0-9][0-9]*\)/\1/p') diff --git a/docs/mk/common.rules.mk b/docs/mk/common.rules.mk deleted file mode 100644 index 698f43317e..0000000000 --- a/docs/mk/common.rules.mk +++ /dev/null @@ -1,54 +0,0 @@ -##===- docs/mk/common.rules.mk -----------------------------*- Makefile -*-===## -# -# The LLVM Compiler Infrastructure -# -# This file is distributed under the University of Illinois Open Source -# License. See LICENSE.TXT for details. -# -##===----------------------------------------------------------------------===## - -# Emit an error for any missing variables which are required to be defined -# before including this makefile-module. -# -_DOCS.vars.missing := $(foreach v,$(DOCS.vars.mandatory),$(if $($v),,$v)) - -ifneq (,$(strip $(_DOCS.vars.missing))) -$(call fn.DUMP.errorn,undefined variable,$(_DOCS.vars.missing)) -endif - -##===----------------------------------------------------------------------===## - -# Basic target to build directory of output files. -# Opaque file lists not visible to target rules need not be added here. -# -$(sort $(dir $(DOCS.mkdir.files))): - $(Echo) Creating directory $(@:$(PROJ_OBJ_ROOT)/%=%) - $(Verb) $(MKDIR) $@ - -##===----------------------------------------------------------------------===## - -# Print help defined by variables added to the help list. -# -.PHONY: -help: - $(foreach h,$(HELP.sections),$(info $())$(info $($h))) - $(info $()) - -##===----------------------------------------------------------------------===## - -printvars:: $(DOCS.vars.mandatory:%=%.print.var) -printvars:: $(DOCS.vars.print:%=%.print.var) - -.PHONY: %.printvar -%.print.var: - @echo '$($*)' | awk -v name='$*' '{ printf("llvm[$(MAKELEVEL)]: %-13s: %s\n",name,$$0) }' - -##===----------------------------------------------------------------------===## - -.PHONY: vars -vars: $(sort $(foreach n,$(filter-out \ - .VARIABLES $(HELP.sections) HELP.%,$(.VARIABLES)),$n.print2.var)) - -.PHONY: %.print2.var -%.print2.var: - @echo "$* = $($*)" diff --git a/docs/mk/main.mk b/docs/mk/main.mk deleted file mode 100644 index 54a7477d6a..0000000000 --- a/docs/mk/main.mk +++ /dev/null @@ -1,243 +0,0 @@ -##===- docs/mk/main.mk -------------------------------------*- Makefile -*-===## -# -# The LLVM Compiler Infrastructure -# -# This file is distributed under the University of Illinois Open Source -# License. See LICENSE.TXT for details. -# -##===----------------------------------------------------------------------===## -# -# Main HTML documentation support module. -# -# The following variables must be defined before including this makefile: -# -# HTML.Project formal project name. eg. LLVM or Clang. -# HTML.project filesystem project name. eg. llvm or clang. -# -##===----------------------------------------------------------------------===## - -include $(LLVM_SRC_ROOT)/docs/mk/common.defs.mk - -MAIN.in/ = $(PROJ_SRC_DIR)/ -MAIN.out/ = ./ - -MAIN.html/ = $(MAIN.out/)html/ -MAIN.html.tar = $(MAIN.out/)html.tar.gz -MAIN.html.cp.ext = .html .css .txt .png .jpg .gif -MAIN.html.cp.in = $(patsubst $(MAIN.in/)%,%, \ - $(sort $(wildcard $(foreach x,$(MAIN.html.cp.ext), $(MAIN.in/)*$(x) ))) \ - $(sort $(wildcard $(foreach x,$(MAIN.html.cp.ext), $(MAIN.in/)*/*$(x) ))) \ - $(sort $(wildcard $(foreach x,$(MAIN.html.cp.ext), $(MAIN.in/)*/*/*$(x) ))) ) -MAIN.html.cp.out = $(MAIN.html.cp.in:%=$(MAIN.html/)%) -MAIN.html.pod.in = $(patsubst $(MAIN.in/)%,%, \ - $(sort $(wildcard $(MAIN.in/)*.pod )) \ - $(sort $(wildcard $(MAIN.in/)*.pod )) \ - $(sort $(wildcard $(MAIN.in/)*/*.pod )) \ - $(sort $(wildcard $(MAIN.in/)*/*/*.pod )) ) -MAIN.html.pod.out = $(MAIN.html.pod.in:%.pod=$(MAIN.html/)%.html) - -MAIN.html.files = $(MAIN.html.cp.out) \ - $(MAIN.html.pod.out) - -MAIN.man/ = $(MAIN.out/)man/man1/ -MAIN.man.in = $(sort $(wildcard $(MAIN.in/)*.pod )) \ - $(sort $(wildcard $(MAIN.in/)*/*.pod )) \ - $(sort $(wildcard $(MAIN.in/)*/*/*.pod )) -MAIN.man.out = $(patsubst %.pod,$(MAIN.man/)%.1,$(notdir $(MAIN.man.in))) - -MAIN.ps/ = $(MAIN.out/)ps/ -MAIN.ps.out = $(patsubst %.1,$(MAIN.ps/)%.ps,$(notdir $(MAIN.man.out))) - -MAIN.pdf/ = $(MAIN.out/)pdf/ -MAIN.pdf.out = $(patsubst %.1,$(MAIN.pdf/)%.pdf,$(notdir $(MAIN.man.out))) - -MAIN.files += $(MAIN.html.tar) -MAIN.files += $(MAIN.html.cp.out) -MAIN.files += $(MAIN.html.pod.out) -MAIN.files += $(MAIN.man.out) -MAIN.files += $(MAIN.ps.out) -MAIN.files += $(MAIN.pdf.out) - -DOCS.mkdir.files += $(MAIN.files) - -##===----------------------------------------------------------------------===## - -INSTALL.out/ = $(PROJ_prefix)/share/ -INSTALL.doc/ = $(INSTALL.out/)doc/$(MAIN.project)/ - -INSTALL.html/ = $(INSTALL.doc/)html/ -INSTALL.html.tar = $(INSTALL.doc/)$(notdir $(MAIN.html.tar)) -INSTALL.html.out = $(MAIN.html.files:$(MAIN.html/)%=$(INSTALL.html/)%) - -INSTALL.man/ = $(PROJ_mandir)/man1/ -INSTALL.man.out = $(MAIN.man.out:$(MAIN.man/)%=$(INSTALL.man/)%) - -INSTALL.ps/ = $(INSTALL.doc/)ps/ -INSTALL.ps.out = $(MAIN.ps.out:$(MAIN.ps/)%=$(INSTALL.ps/)%) - -INSTALL.pdf/ = $(INSTALL.doc/)pdf/ -INSTALL.pdf.out = $(MAIN.pdf.out:$(MAIN.pdf/)%=$(INSTALL.pdf/)%) - -INSTALL.files += $(INSTALL.html.tar) -INSTALL.files += $(INSTALL.html.out) -INSTALL.files += $(INSTALL.man.out) -INSTALL.files += $(INSTALL.ps.out) -INSTALL.files += $(INSTALL.pdf.out) - -DOCS.mkdir.files += $(INSTALL.out/)file-placebo -DOCS.mkdir.files += $(INSTALL.files) - -##===----------------------------------------------------------------------===## - -clean-local:: - -$(Verb) $(RM) -f $(MAIN.files) - -all:: docs docs-tar -install-local:: install-docs -uninstall-local:: uninstall-docs - -##===----------------------------------------------------------------------===## - -.PHONY: docs-tar -docs-tar: $(MAIN.html.tar) - -.PHONY: docs -docs: $(MAIN.html.files) -docs: $(MAIN.man.out) -ifeq ($(ENABLE_DOXYGEN),1) -ifneq (,$(GROFF)) -docs: $(MAIN.ps.out) -endif -ifneq (,$(PDFROFF)) -docs: $(MAIN.pdf.out) -endif -endif - -$(MAIN.html.tar): | $(dir $(MAIN.html.tar)) -$(MAIN.html.tar): $(MAIN.html.files) - $(Echo) Creating $(MAIN.Project) MAIN documentation tarball - $(Verb) (set -e; cd $(MAIN.out/); $(TAR) cf - html) \ - $(call fn.PIPE.COMP,$@) > $@ - -$(MAIN.html.cp.out): | $(dir $(MAIN.html.cp.out)) -$(MAIN.html.cp.out): $(MAIN.html/)%: % - $(Echo) Copying to $(@:$(PROJ_OBJ_ROOT)/%=%) - $(Verb) $(CP) $< $@ - -$(MAIN.html.pod.out): | $(dir $(MAIN.html.pod.out)) -$(MAIN.html.pod.out): $(MAIN.html/)%.html: %.pod - $(Echo) Converting pod to $(@:$(PROJ_OBJ_ROOT)/%=%) - $(Verb) $(CAT) $< | (set -e; cd $(MAIN.in/); $(POD2HTML) --title=$(*F) \ - --noindex --css=manpage.css \ - --htmlroot=. --podpath=. --podroot=$(<D)) > $@ - -$(MAIN.man.out): | $(dir $(MAIN.man.out)) -$(MAIN.man.out): $(MAIN.man/)%.1: %.pod - $(Echo) Converting pod to $(@:$(PROJ_OBJ_ROOT)/%=%) - $(Verb) $(POD2MAN) --release=$(PROJ_VERSION) --center="$(MAIN.man.center)" $< $@ - -$(MAIN.ps.out): | $(dir $(MAIN.ps.out)) -$(MAIN.ps.out): $(MAIN.ps/)%.ps: $(MAIN.man/)%.1 - $(Echo) Converting man to $(@:$(PROJ_OBJ_ROOT)/%=%) - $(Verb) $(GROFF) -Tps -man $< > $@ - -$(MAIN.pdf.out): | $(dir $(MAIN.pdf.out)) -$(MAIN.pdf.out): $(MAIN.pdf/)%.pdf: $(MAIN.man/)%.1 - $(Echo) Converting man to $(@:$(PROJ_OBJ_ROOT)/%=%) - $(Verb) $(PDFROFF) -man --no-toc-relocation $< > $@ - -# Mapping of src pod files is not always direct so we need a search vpath. -# This solution works because no man page filenames (without dir) collide. -vpath %.pod $(sort $(dir $(MAIN.man.in))) - -##===----------------------------------------------------------------------===## - -.PHONY: install-docs -install-docs: $(INSTALL.html.tar) -install-docs: $(INSTALL.html.out) -install-docs: $(INSTALL.man.out) -ifeq ($(ENABLE_DOXYGEN),1) -ifneq (,$(GROFF)) -install-docs: $(INSTALL.ps.out) -endif -ifneq (,$(PDFROFF)) -install-docs: $(INSTALL.pdf.out) -endif -endif - -$(INSTALL.html.tar): | $(dir $(INSTALL.html.tar)) -$(INSTALL.html.tar): $(MAIN.html.tar) - $(Echo) Installing $(MAIN.Project) MAIN documentation tarball - $(Verb) $(DataInstall) $< $@ - -$(INSTALL.html.out): | $(dir $(INSTALL.html.out)) -$(INSTALL.html.out): $(INSTALL.html/)%: $(MAIN.html/)% - $(Echo) Installing $(@:$(INSTALL.out/)%=%) - $(Verb) $(DataInstall) $< $@ - -$(INSTALL.man.out): | $(dir $(INSTALL.man.out)) -$(INSTALL.man.out): $(INSTALL.man/)%: $(MAIN.man/)% - $(Echo) Installing $(@:$(INSTALL.out/)%=%) - $(Verb) $(DataInstall) $< $@ - -$(INSTALL.ps.out): | $(dir $(INSTALL.ps.out)) -$(INSTALL.ps.out): $(INSTALL.ps/)%: $(MAIN.ps/)% - $(Echo) Installing $(@:$(INSTALL.out/)%=%) - $(Verb) $(DataInstall) $< $@ - -$(INSTALL.pdf.out): | $(dir $(INSTALL.pdf.out)) -$(INSTALL.pdf.out): $(INSTALL.pdf/)%: $(MAIN.pdf/)% - $(Echo) Installing $(@:$(INSTALL.out/)%=%) - $(Verb) $(DataInstall) $< $@ - -uninstall-docs: - $(Echo) Uninstalling $(MAIN.Project) MAIN documentation - -$(Verb) $(RM) -f $(INSTALL.files) - -##===----------------------------------------------------------------------===## - -DOCS.vars.mandatory += MAIN.Project MAIN.project MAIN.man.center -DOCS.vars.print += $(sort $(filter INSTALL.%/,$(.VARIABLES))) - -HELP.sections += MAIN.help - -define MAIN.help - MAIN Documentation Module. This module is objdir build-friendly. - - ------------------------------------------------------------------------------ - TARGET NOTES - ------------------------------------------------------------------------------ - *all invokes target docs - *install invokes target install-docs - *uninstall invokes target uninstall-docs - ------------------------------------------------------------------------------ - docs copy MAIN docs from - $(MAIN.in/) - with extensions { $(MAIN.html.cp.ext) } - - and perform conversions: - - FROM TO DESTINATION - -------------------------------------------------------------- - html -> html $(MAIN.html/) - pod -> man $(MAIN.man/) - man -> ps $(MAIN.ps/) - man -> pdf $(MAIN.pdf/) - ------------------------------------------------------------------------------ - docs-tar create docs tarball $(MAIN.html.tar) - clean remove built files - install-docs install MAIN docs: - - FROM TO DESTINATION - -------------------------------------------------------------- - html -> html $(INSTALL.html/) - pod -> man $(INSTALL.man/) - man -> ps $(INSTALL.ps/) - man -> pdf $(INSTALL.pdf/) - ------------------------------------------------------------------------------ - uninstall-docs remove installed files - ------------------------------------------------------------------------------ - (targets marked with '*' require configure --enable-doxygen) -endef - -include $(LLVM_SRC_ROOT)/docs/mk/common.rules.mk diff --git a/docs/main/re_format.7 b/docs/re_format.7 index 0c0928716f..0c0928716f 100644 --- a/docs/main/re_format.7 +++ b/docs/re_format.7 diff --git a/docs/main/tutorial/LangImpl1.html b/docs/tutorial/LangImpl1.html index 66843db5d3..66843db5d3 100644 --- a/docs/main/tutorial/LangImpl1.html +++ b/docs/tutorial/LangImpl1.html diff --git a/docs/main/tutorial/LangImpl2.html b/docs/tutorial/LangImpl2.html index 9c13b486fa..9c13b486fa 100644 --- a/docs/main/tutorial/LangImpl2.html +++ b/docs/tutorial/LangImpl2.html diff --git a/docs/main/tutorial/LangImpl3.html b/docs/tutorial/LangImpl3.html index fe28d41e67..fe28d41e67 100644 --- a/docs/main/tutorial/LangImpl3.html +++ b/docs/tutorial/LangImpl3.html diff --git a/docs/main/tutorial/LangImpl4.html b/docs/tutorial/LangImpl4.html index 230e6e5dc5..230e6e5dc5 100644 --- a/docs/main/tutorial/LangImpl4.html +++ b/docs/tutorial/LangImpl4.html diff --git a/docs/main/tutorial/LangImpl5-cfg.png b/docs/tutorial/LangImpl5-cfg.png Binary files differindex cdba92ff6c..cdba92ff6c 100644 --- a/docs/main/tutorial/LangImpl5-cfg.png +++ b/docs/tutorial/LangImpl5-cfg.png diff --git a/docs/main/tutorial/LangImpl5.html b/docs/tutorial/LangImpl5.html index 7136351bbb..7136351bbb 100644 --- a/docs/main/tutorial/LangImpl5.html +++ b/docs/tutorial/LangImpl5.html diff --git a/docs/main/tutorial/LangImpl6.html b/docs/tutorial/LangImpl6.html index 5fae906c3b..5fae906c3b 100644 --- a/docs/main/tutorial/LangImpl6.html +++ b/docs/tutorial/LangImpl6.html diff --git a/docs/main/tutorial/LangImpl7.html b/docs/tutorial/LangImpl7.html index 0b46ba58ec..0b46ba58ec 100644 --- a/docs/main/tutorial/LangImpl7.html +++ b/docs/tutorial/LangImpl7.html diff --git a/docs/main/tutorial/LangImpl8.html b/docs/tutorial/LangImpl8.html index 64a62002c4..64a62002c4 100644 --- a/docs/main/tutorial/LangImpl8.html +++ b/docs/tutorial/LangImpl8.html diff --git a/docs/tutorial/Makefile b/docs/tutorial/Makefile new file mode 100644 index 0000000000..9082ad4d85 --- /dev/null +++ b/docs/tutorial/Makefile @@ -0,0 +1,28 @@ +##===- docs/tutorial/Makefile ------------------------------*- Makefile -*-===## +# +# The LLVM Compiler Infrastructure +# +# This file is distributed under the University of Illinois Open Source +# License. See LICENSE.TXT for details. +# +##===----------------------------------------------------------------------===## + +LEVEL := ../.. +include $(LEVEL)/Makefile.common + +HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) +EXTRA_DIST := $(HTML) index.html +HTML_DIR := $(DESTDIR)$(PROJ_docsdir)/html/tutorial + +install-local:: $(HTML) + $(Echo) Installing HTML Tutorial Documentation + $(Verb) $(MKDIR) $(HTML_DIR) + $(Verb) $(DataInstall) $(HTML) $(HTML_DIR) + $(Verb) $(DataInstall) $(PROJ_SRC_DIR)/index.html $(HTML_DIR) + +uninstall-local:: + $(Echo) Uninstalling Tutorial Documentation + $(Verb) $(RM) -rf $(HTML_DIR) + +printvars:: + $(Echo) "HTML : " '$(HTML)' diff --git a/docs/main/tutorial/OCamlLangImpl1.html b/docs/tutorial/OCamlLangImpl1.html index 98c1124cc1..98c1124cc1 100644 --- a/docs/main/tutorial/OCamlLangImpl1.html +++ b/docs/tutorial/OCamlLangImpl1.html diff --git a/docs/main/tutorial/OCamlLangImpl2.html b/docs/tutorial/OCamlLangImpl2.html index 666510979f..666510979f 100644 --- a/docs/main/tutorial/OCamlLangImpl2.html +++ b/docs/tutorial/OCamlLangImpl2.html diff --git a/docs/main/tutorial/OCamlLangImpl3.html b/docs/tutorial/OCamlLangImpl3.html index febd7f528c..febd7f528c 100644 --- a/docs/main/tutorial/OCamlLangImpl3.html +++ b/docs/tutorial/OCamlLangImpl3.html diff --git a/docs/main/tutorial/OCamlLangImpl4.html b/docs/tutorial/OCamlLangImpl4.html index 116c618d02..116c618d02 100644 --- a/docs/main/tutorial/OCamlLangImpl4.html +++ b/docs/tutorial/OCamlLangImpl4.html diff --git a/docs/main/tutorial/OCamlLangImpl5.html b/docs/tutorial/OCamlLangImpl5.html index 131d5b252e..131d5b252e 100644 --- a/docs/main/tutorial/OCamlLangImpl5.html +++ b/docs/tutorial/OCamlLangImpl5.html diff --git a/docs/main/tutorial/OCamlLangImpl6.html b/docs/tutorial/OCamlLangImpl6.html index b444fffbc0..b444fffbc0 100644 --- a/docs/main/tutorial/OCamlLangImpl6.html +++ b/docs/tutorial/OCamlLangImpl6.html diff --git a/docs/main/tutorial/OCamlLangImpl7.html b/docs/tutorial/OCamlLangImpl7.html index c140888626..c140888626 100644 --- a/docs/main/tutorial/OCamlLangImpl7.html +++ b/docs/tutorial/OCamlLangImpl7.html diff --git a/docs/main/tutorial/index.html b/docs/tutorial/index.html index 250b533f3f..250b533f3f 100644 --- a/docs/main/tutorial/index.html +++ b/docs/tutorial/index.html |