mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2024-12-21 07:19:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
138aad0ed0
eigen/doc/Doxyfile.in

247 lines
9.2 KiB
Plaintext
Raw Normal View History

move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
# Doxyfile 1.5.3
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = Eigen
release alpha4, Gael edition
2008-02-29 22:50:11 +08:00
PROJECT_NUMBER = 2.0-alpha4
everything works, make now runs doxygen once and only once, after all the required files have been generated.
2007-12-21 19:29:04 +08:00
OUTPUT_DIRECTORY = ${CMAKE_BINARY_DIR}/doc
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = NO
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
- rework the coefficients API - make vectors use a separate loop unroller, so that copying a row-vector into a col-vector is now possible - add much more documentation - misc improvements
2007-12-24 19:14:25 +08:00
ALIASES = \
"only_for_vectors=This is only for vectors (either row-vectors or column-vectors), \
- move: DerivedTraits becomes MatrixBase::Traits - the static constants are private again in the Derived classes - more documentation and code snippets - new isDiagonal() method
2008-01-07 00:35:21 +08:00
i.e. matrices which are known at compile-time to have either one row or one column."
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = NO
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
- rework the coefficients API - make vectors use a separate loop unroller, so that copying a row-vector into a col-vector is now possible - add much more documentation - misc improvements
2007-12-24 19:14:25 +08:00
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
HIDE_FRIEND_COMPOUNDS = YES
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = YES
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
- rework the coefficients API - make vectors use a separate loop unroller, so that copying a row-vector into a col-vector is now possible - add much more documentation - misc improvements
2007-12-24 19:14:25 +08:00
SORT_BRIEF_DOCS = YES
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_DIRECTORIES = NO
FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
- rework the coefficients API - make vectors use a separate loop unroller, so that copying a row-vector into a col-vector is now possible - add much more documentation - misc improvements
2007-12-24 19:14:25 +08:00
WARN_IF_UNDOCUMENTED = NO
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
now we also have a examples/ directory for self-contained examples, and this is already used to document DynBlock
2007-12-21 18:35:00 +08:00
INPUT = ${CMAKE_SOURCE_DIR}/doc ${CMAKE_SOURCE_DIR}/Eigen
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
INPUT_ENCODING = UTF-8
part 2 of the reorganization. Benefits/changes: 1) Eigen2 co-installable with Eigen1 without conflict, without affecting programs including either. 2) #include<Eigen/Core> without the .h without conflict with the Core/ directory 3) Uniformize coding style of the CMakeLists.
2007-12-29 00:20:00 +08:00
FILE_PATTERNS = *
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
RECURSIVE = NO
part 2 of the reorganization. Benefits/changes: 1) Eigen2 co-installable with Eigen1 without conflict, without affecting programs including either. 2) #include<Eigen/Core> without the .h without conflict with the Core/ directory 3) Uniformize coding style of the CMakeLists.
2007-12-29 00:20:00 +08:00
EXCLUDE = CMake* *.txt
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
now we also have a examples/ directory for self-contained examples, and this is already used to document DynBlock
2007-12-21 18:35:00 +08:00
EXAMPLE_PATH = ${CMAKE_SOURCE_DIR}/doc/snippets \
${CMAKE_BINARY_DIR}/doc/snippets \
${CMAKE_SOURCE_DIR}/doc/examples \
first version of CMakeLists auto-generating examples outputs
2007-12-21 17:02:24 +08:00
${CMAKE_BINARY_DIR}/doc/examples
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
USE_HTAGS = NO
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = NO
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
HTML_DYNAMIC_SECTIONS = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
first version of CMakeLists auto-generating examples outputs
2007-12-21 17:02:24 +08:00
GENERATE_LATEX = NO
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
Ready for alpha2 release. - complete documentation - add TODO - update copyright years
2008-01-07 17:34:21 +08:00
EXTRA_PACKAGES = amssymb
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
matrix storage order can now also be row-dominant (choosable for each matrix separately) map() moves from MatrixBase to Matrix much more documentation/examples/snippets
2007-12-28 05:43:10 +08:00
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
matrix storage order can now also be row-dominant (choosable for each matrix separately) map() moves from MatrixBase to Matrix much more documentation/examples/snippets
2007-12-28 05:43:10 +08:00
EXPAND_AS_DEFINED = EIGEN_MAKE_SCALAR_OPS
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
- rework the coefficients API - make vectors use a separate loop unroller, so that copying a row-vector into a col-vector is now possible - add much more documentation - misc improvements
2007-12-24 19:14:25 +08:00
CLASS_DIAGRAMS = NO
MSCGEN_PATH = NO
HIDE_UNDOC_RELATIONS = NO
HAVE_DOT = NO
CLASS_GRAPH = NO
everything works, make now runs doxygen once and only once, after all the required files have been generated.
2007-12-21 19:29:04 +08:00
COLLABORATION_GRAPH = NO
- rework the coefficients API - make vectors use a separate loop unroller, so that copying a row-vector into a col-vector is now possible - add much more documentation - misc improvements
2007-12-24 19:14:25 +08:00
GROUP_GRAPHS = NO
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
- rework the coefficients API - make vectors use a separate loop unroller, so that copying a row-vector into a col-vector is now possible - add much more documentation - misc improvements
2007-12-24 19:14:25 +08:00
INCLUDE_GRAPH = NO
INCLUDED_BY_GRAPH = NO
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
CALL_GRAPH = NO
CALLER_GRAPH = NO
- rework the coefficients API - make vectors use a separate loop unroller, so that copying a row-vector into a col-vector is now possible - add much more documentation - misc improvements
2007-12-24 19:14:25 +08:00
GRAPHICAL_HIERARCHY = NO
DIRECTORY_GRAPH = NO
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 1000
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
- rework the coefficients API - make vectors use a separate loop unroller, so that copying a row-vector into a col-vector is now possible - add much more documentation - misc improvements
2007-12-24 19:14:25 +08:00
GENERATE_LEGEND = NO
DOT_CLEANUP = NO
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs
2007-12-21 15:30:15 +08:00
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
Reference in New Issue Copy Permalink