Removing old doc folder, now moved to VA parent project

parent 8a85c31d
#
# OpenDAFF Documentation Makefile
# Authors: Frank Wefers (Frank.Wefers@akustik.rwth-aachen.de),
# Jonas Stienen (stienen@akustik.rwth-aachen.de)
# Date/Version: $Id: Makefile,v 1.1 2010/02/04 15:02:36 fwefers Exp $
# (c) Copyright Institute of Technical Acoustics (ITA), RWTH Aachen University 2009-2010
#
#
# Makefile for generating the ITAToolkit documentation files under Linux machines using doxygen (>= 1.5.5)
#
DOC_NAME = OpenDAFF Documentation
DOX = doxygen
DOX_CONFIG_FILE = cxx-api.doxyfile
DOX_HTML_TARGET = HTML
#DOX_STYLESHEET = styles.css
DOX_IMAGES = logo.png
.PHONY: clean
.PHONY: doc
.PHONY: info
all: doc
doc:
$(MAKE) clean
$(DOX) $(DOX_CONFIG_FILE)
cp $(DOX_STYLESHEET) $(DOX_HTML_TARGET)
cp $(DOX_IMAGES) $(DOX_HTML_TARGET)
clean:
rm -rf $(DOX_HTML_TARGET)
info:
@echo "--- Generate $(DOC_NAME) ---"
@echo "Execute \`make\` to generate the documentation files to its target directory '$(DOX_HTML_TARGET)'."
@echo "If there are already some older versions existing, they will be removed."
@echo "Type in \`make clean\` to remove the documentation."
@echo ""
@echo "--- Settings ---"
@echo "DOX = $(DOX)"
@echo "DOX_CONFIG_FILE = $(DOX_CONFIG_FILE)"
@echo "DOX_HTML_TARGET = $(DOX_HTML_TARGET)"
@echo "DOX_STYLESHEET = $(DOX_STYLESHEET)"
@echo "DOX_IMAGES = $(DOX_IMAGES)"
# Doxyfile 1.5.4
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "VABase C++ Application Programming Interface (API)"
PROJECT_NUMBER =
OUTPUT_DIRECTORY =
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 = YES
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
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
TYPEDEF_HIDES_STRUCT = NO
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = NO
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = NO
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
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
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = ../include
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h
RECURSIVE = NO
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
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 = NO
REFERENCES_RELATION = NO
REFERENCES_LINK_SOURCE = YES
USE_HTAGS = NO
VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# 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 = doxygen.header.html
HTML_FOOTER = doxygen.footer.html
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
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
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
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
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
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = NO
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 1000
DOT_TRANSPARENT = YES
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
</DIV>
<DIV STYLE="margin-top: 6em;">
<CENTER>
&COPY; Copyright <A HREF="http:/www.akustik.rwth-aachen.de" TARGET="_blank">Institut f&uuml;r Technische Akustik</A>, RWTH-Aachen, 2009-2010
</CENTER>
</DIV>
</BODY>
</HTML>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<TITLE>$projectname - $title</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="tabs.css" REL="stylesheet" TYPE="text/css">
<META http-equiv="Content-Type" content="text/html; charset=UTF8">
</HEAD>
<BODY "STYLE="margin: 2em;">
<!--
<CENTER>
<IMG SRC="logo.png" ALT="VABase" BORDER="0" ALIGN="ABSMIDDLE"/>
</CENTER>
-->
<DIV STYLE="margin-top: 3em;">
\ No newline at end of file
doxygen cxx-api.doxyfile
copy logo.png html
REM copy styles.css html
......@@ -140,7 +140,7 @@ public:
* progress events are send to all attached event handlers, informing about
* the current status. This happens during the call to the method.
*
* \important Initialization does not detach event handlers
* @note Initialization does not detach event handlers
*/
virtual void Initialize() = 0;
......@@ -156,7 +156,7 @@ public:
* used anymore and is within the VA_CORESTATE_FAIL.
* It shall be destroyed in this case.
*
* \important Finalization does not detach event handlers
* @note Finalization does not detach event handlers
*/
virtual void Finalize() = 0;
......@@ -174,7 +174,7 @@ public:
//! Attaches a handler for core events to the core instance
/**
* \important Attaching event handlers it always possible,
* @note Attaching event handlers it always possible,
* regardless of the state of the core.
* This method can therefore be called anytime,
* also before initialization and after finalization.
......@@ -183,7 +183,7 @@ public:
//! Detaches a handler for core events from the core instance
/**
* \important Detaching event handlers it always possible,
* @note Detaching event handlers it always possible,
* regardless of the state of the core.
* This method can therefore be called anytime,
* also before initialization and after finalization.
......@@ -1087,7 +1087,7 @@ public:
* \note The parameter iListenerID has been added for future versions and is
* currently unsupported. You can set it any value you like.
*
* \important Coordinates refer the to center of the head on the axis
* @note Coordinates refer the to center of the head on the axis
* which goes through both ears.
*/
virtual void GetListenerRealWorldHeadPositionOrientationVU( int iListenerID, double& px, double& py, double& pz, double& vx, double& vy, double& vz, double& ux, double& uy, double& uz ) const = 0;
......@@ -1100,7 +1100,7 @@ public:
* \note The parameter iListenerID has been added for future versions and is
* currently unsupported. You can set it any value you like.
*
* \important Coordinates refer the to center of the head on the axis
* @note Coordinates refer the to center of the head on the axis
* which goes through both ears.
*/
virtual void SetListenerRealWorldHeadPositionOrientationVU( int iListenerID, double px, double py, double pz, double vx, double vy, double vz, double ux, double uy, double uz ) = 0;
......
......@@ -84,7 +84,6 @@ public:
//! Deletes all keys
void Clear();
//! Removes a key and its value (supports paths)
bool RemoveKey( const std::string& sKey );
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment