source: LinearAlgebra/doc/Doxyfile@ 3e236e

Action_Thermostats Add_AtomRandomPerturbation Add_FitFragmentPartialChargesAction Add_RotateAroundBondAction Add_SelectAtomByNameAction Added_ParseSaveFragmentResults AddingActions_SaveParseParticleParameters Adding_Graph_to_ChangeBondActions Adding_MD_integration_tests Adding_ParticleName_to_Atom Adding_StructOpt_integration_tests AtomFragments Automaking_mpqc_open AutomationFragmentation_failures Candidate_v1.5.4 Candidate_v1.6.0 Candidate_v1.6.1 Candidate_v1.7.0 ChangeBugEmailaddress ChangingTestPorts ChemicalSpaceEvaluator CombiningParticlePotentialParsing Combining_Subpackages Debian_Package_split Debian_package_split_molecuildergui_only Disabling_MemDebug Docu_Python_wait EmpiricalPotential_contain_HomologyGraph EmpiricalPotential_contain_HomologyGraph_documentation Enable_parallel_make_install Enhance_userguide Enhanced_StructuralOptimization Enhanced_StructuralOptimization_continued Example_ManyWaysToTranslateAtom Exclude_Hydrogens_annealWithBondGraph FitPartialCharges_GlobalError Fix_BoundInBox_CenterInBox_MoleculeActions Fix_ChargeSampling_PBC Fix_ChronosMutex Fix_FitPartialCharges Fix_FitPotential_needs_atomicnumbers Fix_ForceAnnealing Fix_IndependentFragmentGrids Fix_ParseParticles Fix_ParseParticles_split_forward_backward_Actions Fix_PopActions Fix_QtFragmentList_sorted_selection Fix_Restrictedkeyset_FragmentMolecule Fix_StatusMsg Fix_StepWorldTime_single_argument Fix_Verbose_Codepatterns Fix_fitting_potentials Fixes ForceAnnealing_goodresults ForceAnnealing_oldresults ForceAnnealing_tocheck ForceAnnealing_with_BondGraph ForceAnnealing_with_BondGraph_continued ForceAnnealing_with_BondGraph_continued_betteresults ForceAnnealing_with_BondGraph_contraction-expansion FragmentAction_writes_AtomFragments FragmentMolecule_checks_bonddegrees GeometryObjects Gui_Fixes Gui_displays_atomic_force_velocity ImplicitCharges IndependentFragmentGrids IndependentFragmentGrids_IndividualZeroInstances IndependentFragmentGrids_IntegrationTest IndependentFragmentGrids_Sole_NN_Calculation JobMarket_RobustOnKillsSegFaults JobMarket_StableWorkerPool JobMarket_unresolvable_hostname_fix MoreRobust_FragmentAutomation ODR_violation_mpqc_open PartialCharges_OrthogonalSummation PdbParser_setsAtomName PythonUI_with_named_parameters QtGui_reactivate_TimeChanged_changes Recreated_GuiChecks Rewrite_FitPartialCharges RotateToPrincipalAxisSystem_UndoRedo SaturateAtoms_findBestMatching SaturateAtoms_singleDegree StoppableMakroAction Subpackage_CodePatterns Subpackage_JobMarket Subpackage_LinearAlgebra Subpackage_levmar Subpackage_mpqc_open Subpackage_vmg Switchable_LogView ThirdParty_MPQC_rebuilt_buildsystem TrajectoryDependenant_MaxOrder TremoloParser_IncreasedPrecision TremoloParser_MultipleTimesteps TremoloParser_setsAtomName Ubuntu_1604_changes stable
Last change on this file since 3e236e was ce133f, checked in by Frederik Heber <heber@…>, 14 years ago

Initial commit for enhancing doxygen documentation.

  • added .dox types to FILE_TYPES in Doxyfile.
  • added folders documentation to both src/ and LinearAlgebra/src.
  • added some preliminary files to both which should be filled.
  • the idea is to have all documentation that is not associable to a specific class (e.g. serialization) in an extra file.
  • also we should introduce groups and generally order and enhance documentation.
  • Property mode set to 100755
File size: 9.4 KB
Line 
1# Doxyfile 1.4.5
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6PROJECT_NAME = $(PROJECT)
7PROJECT_NUMBER = $(VERSION)
8OUTPUT_DIRECTORY = $(DOCDIR)
9CREATE_SUBDIRS = NO
10OUTPUT_LANGUAGE = English
11USE_WINDOWS_ENCODING = YES
12BRIEF_MEMBER_DESC = YES
13REPEAT_BRIEF = YES
14ABBREVIATE_BRIEF = "The $name class" \
15 "The $name widget" \
16 "The $name file" \
17 is \
18 provides \
19 specifies \
20 contains \
21 represents \
22 a \
23 an \
24 the
25ALWAYS_DETAILED_SEC = NO
26INLINE_INHERITED_MEMB = NO
27FULL_PATH_NAMES = YES
28STRIP_FROM_PATH = ../bin/
29STRIP_FROM_INC_PATH =
30SHORT_NAMES = NO
31JAVADOC_AUTOBRIEF = YES
32MULTILINE_CPP_IS_BRIEF = NO
33DETAILS_AT_TOP = NO
34INHERIT_DOCS = YES
35SEPARATE_MEMBER_PAGES = NO
36TAB_SIZE = 3
37ALIASES =
38OPTIMIZE_OUTPUT_FOR_C = YES
39OPTIMIZE_OUTPUT_JAVA = NO
40#BUILTIN_STL_SUPPORT = NO
41DISTRIBUTE_GROUP_DOC = NO
42SUBGROUPING = YES
43#---------------------------------------------------------------------------
44# Build related configuration options
45#---------------------------------------------------------------------------
46EXTRACT_ALL = YES
47EXTRACT_PRIVATE = YES
48EXTRACT_STATIC = YES
49EXTRACT_LOCAL_CLASSES = YES
50EXTRACT_LOCAL_METHODS = YES
51HIDE_UNDOC_MEMBERS = NO
52HIDE_UNDOC_CLASSES = NO
53HIDE_FRIEND_COMPOUNDS = NO
54HIDE_IN_BODY_DOCS = NO
55INTERNAL_DOCS = YES
56CASE_SENSE_NAMES = NO
57HIDE_SCOPE_NAMES = NO
58SHOW_INCLUDE_FILES = YES
59INLINE_INFO = YES
60SORT_MEMBER_DOCS = YES
61SORT_BRIEF_DOCS = NO
62SORT_BY_SCOPE_NAME = NO
63GENERATE_TODOLIST = YES
64GENERATE_TESTLIST = YES
65GENERATE_BUGLIST = YES
66GENERATE_DEPRECATEDLIST= YES
67ENABLED_SECTIONS =
68MAX_INITIALIZER_LINES = 30
69SHOW_USED_FILES = YES
70SHOW_DIRECTORIES = NO
71FILE_VERSION_FILTER =
72#---------------------------------------------------------------------------
73# configuration options related to warning and progress messages
74#---------------------------------------------------------------------------
75QUIET = NO
76WARNINGS = YES
77WARN_IF_UNDOCUMENTED = YES
78WARN_IF_DOC_ERROR = YES
79WARN_NO_PARAMDOC = NO
80WARN_FORMAT = "$file:$line: $text"
81WARN_LOGFILE =
82#---------------------------------------------------------------------------
83# configuration options related to the input files
84#---------------------------------------------------------------------------
85INPUT = $(TOPSRCDIR)/src
86FILE_PATTERNS = *.c \
87 *.cc \
88 *.cxx \
89 *.cpp \
90 *.c++ \
91 *.d \
92 *.dox \
93 *.java \
94 *.ii \
95 *.ixx \
96 *.ipp \
97 *.i++ \
98 *.inl \
99 *.h \
100 *.hh \
101 *.hxx \
102 *.hpp \
103 *.h++ \
104 *.idl \
105 *.odl \
106 *.cs \
107 *.php \
108 *.php3 \
109 *.inc \
110 *.m \
111 *.mm \
112 *.dox \
113 *.py
114RECURSIVE = YES
115EXCLUDE =
116EXCLUDE_SYMLINKS = NO
117EXCLUDE_PATTERNS = */unittests/* \
118 */test/*
119EXAMPLE_PATH =
120EXAMPLE_PATTERNS = *
121EXAMPLE_RECURSIVE = NO
122IMAGE_PATH =
123INPUT_FILTER =
124FILTER_PATTERNS =
125FILTER_SOURCE_FILES = NO
126#---------------------------------------------------------------------------
127# configuration options related to source browsing
128#---------------------------------------------------------------------------
129SOURCE_BROWSER = YES
130INLINE_SOURCES = YES
131STRIP_CODE_COMMENTS = NO
132REFERENCED_BY_RELATION = NO
133REFERENCES_RELATION = NO
134USE_HTAGS = NO
135VERBATIM_HEADERS = NO
136#---------------------------------------------------------------------------
137# configuration options related to the alphabetical class index
138#---------------------------------------------------------------------------
139ALPHABETICAL_INDEX = NO
140COLS_IN_ALPHA_INDEX = 5
141IGNORE_PREFIX =
142#---------------------------------------------------------------------------
143# configuration options related to the HTML output
144#---------------------------------------------------------------------------
145GENERATE_HTML = YES
146HTML_OUTPUT = html
147HTML_FILE_EXTENSION = .html
148HTML_HEADER =
149HTML_FOOTER =
150HTML_STYLESHEET =
151HTML_ALIGN_MEMBERS = YES
152GENERATE_HTMLHELP = NO
153CHM_FILE =
154HHC_LOCATION =
155GENERATE_CHI = NO
156BINARY_TOC = NO
157TOC_EXPAND = NO
158DISABLE_INDEX = NO
159ENUM_VALUES_PER_LINE = 4
160GENERATE_TREEVIEW = NO
161TREEVIEW_WIDTH = 250
162#---------------------------------------------------------------------------
163# configuration options related to the LaTeX output
164#---------------------------------------------------------------------------
165GENERATE_LATEX = NO
166LATEX_OUTPUT = latex
167LATEX_CMD_NAME = latex
168MAKEINDEX_CMD_NAME = makeindex
169COMPACT_LATEX = NO
170PAPER_TYPE = a4wide
171EXTRA_PACKAGES =
172LATEX_HEADER =
173PDF_HYPERLINKS = YES
174USE_PDFLATEX = YES
175LATEX_BATCHMODE = NO
176LATEX_HIDE_INDICES = NO
177#---------------------------------------------------------------------------
178# configuration options related to the RTF output
179#---------------------------------------------------------------------------
180GENERATE_RTF = NO
181RTF_OUTPUT = rtf
182COMPACT_RTF = NO
183RTF_HYPERLINKS = NO
184RTF_STYLESHEET_FILE =
185RTF_EXTENSIONS_FILE =
186#---------------------------------------------------------------------------
187# configuration options related to the man page output
188#---------------------------------------------------------------------------
189GENERATE_MAN = NO
190MAN_OUTPUT = man
191MAN_EXTENSION = .3
192MAN_LINKS = NO
193#---------------------------------------------------------------------------
194# configuration options related to the XML output
195#---------------------------------------------------------------------------
196GENERATE_XML = NO
197XML_OUTPUT = xml
198XML_SCHEMA =
199XML_DTD =
200XML_PROGRAMLISTING = YES
201#---------------------------------------------------------------------------
202# configuration options for the AutoGen Definitions output
203#---------------------------------------------------------------------------
204GENERATE_AUTOGEN_DEF = NO
205#---------------------------------------------------------------------------
206# configuration options related to the Perl module output
207#---------------------------------------------------------------------------
208GENERATE_PERLMOD = NO
209PERLMOD_LATEX = NO
210PERLMOD_PRETTY = YES
211PERLMOD_MAKEVAR_PREFIX =
212#---------------------------------------------------------------------------
213# Configuration options related to the preprocessor
214#---------------------------------------------------------------------------
215ENABLE_PREPROCESSING = YES
216MACRO_EXPANSION = NO
217EXPAND_ONLY_PREDEF = NO
218SEARCH_INCLUDES = YES
219INCLUDE_PATH =
220INCLUDE_FILE_PATTERNS =
221PREDEFINED =
222EXPAND_AS_DEFINED =
223SKIP_FUNCTION_MACROS = YES
224#---------------------------------------------------------------------------
225# Configuration::additions related to external references
226#---------------------------------------------------------------------------
227TAGFILES =
228GENERATE_TAGFILE =
229ALLEXTERNALS = NO
230EXTERNAL_GROUPS = YES
231PERL_PATH = /usr/bin/perl
232#---------------------------------------------------------------------------
233# Configuration options related to the dot tool
234#---------------------------------------------------------------------------
235CLASS_DIAGRAMS = YES
236HIDE_UNDOC_RELATIONS = YES
237HAVE_DOT = NO
238CLASS_GRAPH = YES
239COLLABORATION_GRAPH = YES
240GROUP_GRAPHS = YES
241UML_LOOK = NO
242TEMPLATE_RELATIONS = NO
243INCLUDE_GRAPH = YES
244INCLUDED_BY_GRAPH = YES
245CALL_GRAPH = NO
246GRAPHICAL_HIERARCHY = YES
247DIRECTORY_GRAPH = YES
248DOT_IMAGE_FORMAT = png
249DOT_PATH =
250DOTFILE_DIRS =
251MAX_DOT_GRAPH_WIDTH = 1024
252MAX_DOT_GRAPH_HEIGHT = 1024
253MAX_DOT_GRAPH_DEPTH = 1000
254DOT_TRANSPARENT = NO
255DOT_MULTI_TARGETS = NO
256GENERATE_LEGEND = YES
257DOT_CLEANUP = YES
258#---------------------------------------------------------------------------
259# Configuration::additions related to the search engine
260#---------------------------------------------------------------------------
261SEARCHENGINE = YES
Note: See TracBrowser for help on using the repository browser.