commit 04b7f185667ce70d4e6c75758c4bcda28fd48892
parent 4e318b9d461b2ca86c9360c5a4a624c578dd9299
Author: Étienne Simon <etienne.jl.simon@gmail.com>
Date: Sun, 5 May 2013 22:08:58 +0200
Update/correct doxygen comments/config file.
Diffstat:
7 files changed, 179 insertions(+), 152 deletions(-)
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
@@ -1,4 +1,4 @@
-# Doxyfile 1.7.6.1
+# Doxyfile 1.8.2
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
@@ -126,7 +126,9 @@ FULL_PATH_NAMES = YES
# 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.
+# path to strip. Note that you specify absolute paths here, but also
+# relative paths, which will be relative from the directory where doxygen is
+# started.
STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@/../src/
@@ -229,17 +231,34 @@ OPTIMIZE_FOR_FORTRAN = NO
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, CSharp, 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.
+# 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, CSharp, 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 MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
+# comments according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you
+# can mix doxygen, HTML, and XML commands with Markdown formatting.
+# Disable only in case of backward compatibilities issues.
+
+MARKDOWN_SUPPORT = YES
+
+# When enabled doxygen tries to link words that correspond to documented classes,
+# or namespaces to their corresponding documentation. Such a link can be
+# prevented in individual cases by by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+
+AUTOLINK_SUPPORT = YES
+
# 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
@@ -260,12 +279,7 @@ CPP_CLI_SUPPORT = NO
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 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.
+# 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 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 = NO
@@ -353,6 +367,11 @@ EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# scope will be included in the documentation.
+
+EXTRACT_PACKAGE = NO
+
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
@@ -540,12 +559,6 @@ MAX_INITIALIZER_LINES = 30
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
-# in the documentation. The default is NO.
-
-SHOW_DIRECTORIES = NO
-
# 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
# Folder Tree View (if specified). The default is YES.
@@ -571,7 +584,7 @@ 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
+# output files in an output format independent way. To 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.
@@ -785,7 +798,7 @@ 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
-# fragments. Normal C and C++ comments will always remain visible.
+# fragments. Normal C, C++ and Fortran comments will always remain visible.
STRIP_CODE_COMMENTS = NO
@@ -888,13 +901,23 @@ HTML_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
-# style sheet in the HTML output directory as well, or it will be erased!
+# fine-tune the look of the HTML output. If left blank doxygen will
+# generate a default style sheet. Note that it is recommended to use
+# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
+# tag will in the future become obsolete.
HTML_STYLESHEET =
+# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
+# user-defined cascading style sheet that is included after the standard
+# style sheets created by doxygen. Using this option one can overrule
+# certain style aspects. This is preferred over using HTML_STYLESHEET
+# since it does not replace the standard style sheet and is therefor more
+# robust against future updates. Doxygen will copy the style sheet file to
+# the output directory.
+
+HTML_EXTRA_STYLESHEET =
+
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
# that these files will be copied to the base HTML output directory. Use the
@@ -935,20 +958,23 @@ HTML_COLORSTYLE_GAMMA = 80
HTML_TIMESTAMP = YES
-# 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).
+# page has loaded.
HTML_DYNAMIC_SECTIONS = NO
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
+# entries shown in the various tree structured indices initially; the user
+# can expand and collapse entries dynamically later on. Doxygen will expand
+# the tree to such a level that at most the specified number of entries are
+# visible (unless a fully collapsed tree already exceeds this amount).
+# So setting the number of entries 1 will produce a full collapsed tree by
+# default. 0 is a special value representing an infinite number of entries
+# and will result in a full expanded tree by default.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
# 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).
@@ -976,9 +1002,9 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project
-# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
-# the documentation publisher. This should be a reverse domain-name style
-# string, e.g. com.mycompany.MyDocSet.documentation.
+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
+# identify the documentation publisher. This should be a reverse domain-name
+# style string, e.g. com.mycompany.MyDocSet.documentation.
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
@@ -1127,11 +1153,6 @@ GENERATE_TREEVIEW = NO
ENUM_VALUES_PER_LINE = 4
-# 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
# is shown.
@@ -1163,7 +1184,7 @@ FORMULA_TRANSPARENT = YES
# (see http://www.mathjax.org) which uses client side Javascript for the
# rendering instead of using prerendered bitmaps. Use this if you do not
# have LaTeX installed or if you want to formulas look prettier in the HTML
-# output. When enabled you also need to install MathJax separately and
+# output. When enabled you may also need to install MathJax separately and
# configure the path to it using the MATHJAX_RELPATH option.
USE_MATHJAX = NO
@@ -1172,10 +1193,11 @@ USE_MATHJAX = NO
# HTML output directory using the MATHJAX_RELPATH option. The destination
# directory should contain the MathJax.js script. For instance, if the mathjax
# directory is located at the same level as the HTML output directory, then
-# MATHJAX_RELPATH should be ../mathjax. The default value points to the
-# mathjax.org site, so you can quickly see the result without installing
-# MathJax, but it is strongly recommended to install a local copy of MathJax
-# before deployment.
+# MATHJAX_RELPATH should be ../mathjax. The default value points to
+# the MathJax Content Delivery Network so you can quickly see the result without
+# installing MathJax.
+# However, it is strongly recommended to install a local
+# copy of MathJax from http://www.mathjax.org before deployment.
MATHJAX_RELPATH = http://www.mathjax.org/mathjax
@@ -1525,22 +1547,18 @@ SKIP_FUNCTION_MACROS = YES
# 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:
+# The TAGFILES option can be used to specify one or more tagfiles. For each
+# tag file the location of the external documentation should be added. 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
-# is run, you must also specify the path to the tagfile here.
+# where "loc1" and "loc2" can be relative or absolute paths
+# or URLs. 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 is run, you must also specify the path to the tagfile here.
TAGFILES =
@@ -1653,6 +1671,15 @@ GROUP_GRAPHS = YES
UML_LOOK = NO
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside
+# the class node. If there are many fields or methods and many nodes the
+# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
+# threshold limits the number of items for each type to make the size more
+# managable. Set this to 0 for no limit. Note that the threshold may be
+# exceeded by 50% before the limit is enforced.
+
+UML_LIMIT_NUM_FIELDS = 10
+
# If set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.
@@ -1693,7 +1720,7 @@ CALLER_GRAPH = YES
GRAPHICAL_HIERARCHY = YES
-# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# If the DIRECTORY_GRAPH 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.
diff --git a/src/model.cpp b/src/model.cpp
@@ -51,7 +51,7 @@ void Model::stochastic_learn(Data_set const &data_set, std::size_t number_of_ste
criteria[i]=criterion_factory(criterion, view_vector[i]->view_dimension);
boost::shared_ptr<Tensor> input=boost::make_shared<Tensor>(1), output=boost::make_shared<Tensor>(1);
- /// @fixme Very inefficient...
+ /// @todo Optimise
for(std::size_t step=0; step<number_of_step*data_set.size(); ++step){
std::size_t element=data_dist(gen);
std::size_t from_id=view_dist(gen), to_id=view_dist(gen);
diff --git a/src/nmlp_base_iostream.hpp b/src/nmlp_base_iostream.hpp
@@ -2,7 +2,7 @@
* @file
* @brief nmlp base classe iostream function declarations.
*
- * @attention This file can be included in multiple translation unit, but then, the file @ref nmlp_iostream_exports.hpp must be included once per binary.
+ * @attention This file can be included in multiple translation unit, but then, the file nmlp_iostream_exports.hpp must be included once per binary.
*/
#ifndef NMLP_BASE_IOSTREAM_HPP_INCLUDED
@@ -15,66 +15,66 @@
#include <nmlp/GPUMatrix.h>
#include <nmlp/Tensor.h>
-/** @brief Serialization save operator of @ref CPUMatrix. */
+/** @brief Serialization save operator of CPUMatrix. */
template<class Archive>
void save(Archive &ar, CPUMatrix const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPUMatrix. */
+/** @brief Serialization pre-save operator of CPUMatrix. */
template<class Archive>
void save_construct_data(Archive &ar, CPUMatrix const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPUMatrix. */
+/** @brief Serialization load operator of CPUMatrix. */
template<class Archive>
void load(Archive &ar, CPUMatrix &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPUMatrix. */
+/** @brief Serialization pre-load operator of CPUMatrix. */
template<class Archive>
void load_construct_data(Archive &ar, CPUMatrix *rhs, unsigned const version);
-/** @brief Serialization save operator of @ref GPUMatrix. */
+/** @brief Serialization save operator of GPUMatrix. */
template<class Archive>
void save(Archive &ar, GPUMatrix const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref GPUMatrix. */
+/** @brief Serialization pre-save operator of GPUMatrix. */
template<class Archive>
void save_construct_data(Archive &ar, GPUMatrix const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref GPUMatrix. */
+/** @brief Serialization load operator of GPUMatrix. */
template<class Archive>
void load(Archive &ar, GPUMatrix &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref GPUMatrix. */
+/** @brief Serialization pre-load operator of GPUMatrix. */
template<class Archive>
void load_construct_data(Archive &ar, GPUMatrix *rhs, unsigned const version);
/**
- * @brief Serialization save operator of @ref CPUSparseMatrix.
+ * @brief Serialization save operator of CPUSparseMatrix.
*
- * @attention @ref CPUSparseMatrix is accessed through a member iterator, it is set to end after this function is called.
+ * @attention CPUSparseMatrix is accessed through a member iterator, it is set to end after this function is called.
*/
template<class Archive>
void save(Archive &ar, CPUSparseMatrix const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPUSparseMatrix. */
+/** @brief Serialization pre-save operator of CPUSparseMatrix. */
template<class Archive>
void save_construct_data(Archive &ar, CPUSparseMatrix const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPUSparseMatrix.
+/** @brief Serialization load operator of CPUSparseMatrix.
*
- * @attention @ref CPUSparseMatrix is accessed through a member iterator, it is set to end after this function is called.
+ * @attention CPUSparseMatrix is accessed through a member iterator, it is set to end after this function is called.
*/
template<class Archive>
void load(Archive &ar, CPUSparseMatrix &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPUSparseMatrix. */
+/** @brief Serialization pre-load operator of CPUSparseMatrix. */
template<class Archive>
void load_construct_data(Archive &ar, CPUSparseMatrix *rhs, unsigned const version);
-/** @brief Serialization save operator of @ref Tensor. */
+/** @brief Serialization save operator of Tensor. */
template<class Archive>
void save(Archive &ar, Tensor const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref Tensor. */
+/** @brief Serialization pre-save operator of Tensor. */
template<class Archive>
void save_construct_data(Archive &ar, Tensor const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref Tensor. */
+/** @brief Serialization load operator of Tensor. */
template<class Archive>
void load(Archive &ar, Tensor &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref Tensor. */
+/** @brief Serialization pre-load operator of Tensor. */
template<class Archive>
void load_construct_data(Archive &ar, Tensor *rhs, unsigned const version);
diff --git a/src/nmlp_criterion_iostream.hpp b/src/nmlp_criterion_iostream.hpp
@@ -2,7 +2,7 @@
* @file
* @brief nmlp criterions iostream function declarations.
*
- * @attention This file can be included in multiple translation unit, but then, the file @ref nmlp_iostream_exports.hpp must be included once per binary.
+ * @attention This file can be included in multiple translation unit, but then, the file nmlp_iostream_exports.hpp must be included once per binary.
*/
#ifndef NMLP_CRITERION_IOSTREAM_HPP_INCLUDED
@@ -16,62 +16,62 @@
#include <nmlp/criterions/GPUHingeLoss.h>
#include <nmlp/criterions/GPUSquareLoss.h>
-/** @brief Serialization operator of @ref CPUMaxLoss. */
+/** @brief Serialization operator of CPUMaxLoss. */
template<class Archive>
void serialize(Archive &ar, CPUMaxLoss &rhs, unsigned const version);
-/** @brief Serialization save operator of @ref CPUHingeLoss. */
+/** @brief Serialization save operator of CPUHingeLoss. */
template<class Archive>
void save(Archive &ar, CPUHingeLoss const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPUHingeLoss. */
+/** @brief Serialization pre-save operator of CPUHingeLoss. */
template<class Archive>
void save_construct_data(Archive &ar, CPUHingeLoss const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPUHingeLoss. */
+/** @brief Serialization load operator of CPUHingeLoss. */
template<class Archive>
void load(Archive &ar, CPUHingeLoss &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPUHingeLoss. */
+/** @brief Serialization pre-load operator of CPUHingeLoss. */
template<class Archive>
void save_construct_data(Archive &ar, CPUHingeLoss *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(CPUHingeLoss)
-/** @brief Serialization save operator of @ref CPUSquareLoss. */
+/** @brief Serialization save operator of CPUSquareLoss. */
template<class Archive>
void save(Archive &ar, CPUSquareLoss const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPUSquareLoss. */
+/** @brief Serialization pre-save operator of CPUSquareLoss. */
template<class Archive>
void save_construct_data(Archive &ar, CPUSquareLoss const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPUSquareLoss. */
+/** @brief Serialization load operator of CPUSquareLoss. */
template<class Archive>
void load(Archive &ar, CPUSquareLoss &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPUSquareLoss. */
+/** @brief Serialization pre-load operator of CPUSquareLoss. */
template<class Archive>
void save_construct_data(Archive &ar, CPUSquareLoss *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(CPUSquareLoss)
-/** @brief Serialization save operator of @ref GPUHingeLoss. */
+/** @brief Serialization save operator of GPUHingeLoss. */
template<class Archive>
void save(Archive &ar, GPUHingeLoss const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref GPUHingeLoss. */
+/** @brief Serialization pre-save operator of GPUHingeLoss. */
template<class Archive>
void save_construct_data(Archive &ar, GPUHingeLoss const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref GPUHingeLoss. */
+/** @brief Serialization load operator of GPUHingeLoss. */
template<class Archive>
void load(Archive &ar, GPUHingeLoss &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref GPUHingeLoss. */
+/** @brief Serialization pre-load operator of GPUHingeLoss. */
template<class Archive>
void save_construct_data(Archive &ar, GPUHingeLoss *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(GPUHingeLoss)
-/** @brief Serialization save operator of @ref GPUSquareLoss. */
+/** @brief Serialization save operator of GPUSquareLoss. */
template<class Archive>
void save(Archive &ar, GPUSquareLoss const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref GPUSquareLoss. */
+/** @brief Serialization pre-save operator of GPUSquareLoss. */
template<class Archive>
void save_construct_data(Archive &ar, GPUSquareLoss const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref GPUSquareLoss. */
+/** @brief Serialization load operator of GPUSquareLoss. */
template<class Archive>
void load(Archive &ar, GPUSquareLoss &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref GPUSquareLoss. */
+/** @brief Serialization pre-load operator of GPUSquareLoss. */
template<class Archive>
void save_construct_data(Archive &ar, GPUSquareLoss *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(GPUSquareLoss)
diff --git a/src/nmlp_module_iostream.hpp b/src/nmlp_module_iostream.hpp
@@ -2,7 +2,7 @@
* @file
* @brief nmlp modules iostream function declarations.
*
- * @attention This file can be included in multiple translation unit, but then, the file @ref nmlp_iostream_exports.hpp must be included once per binary.
+ * @attention This file can be included in multiple translation unit, but then, the file nmlp_iostream_exports.hpp must be included once per binary.
*/
#ifndef NMLP_MODULE_IOSTREAM_HPP_INCLUDED
@@ -30,173 +30,173 @@
* @note There is an error in nmlp/modules/GPUShrink.h and nmlp/modules/CPUShrink.h.
*/
-/** @brief Serialization operator of @ref TableModule. */
+/** @brief Serialization operator of TableModule. */
template<class Archive>
void serialize(Archive &ar, TableModule &rhs, unsigned const version);
-/** @brief Serialization operator of @ref SequentialModule. */
+/** @brief Serialization operator of SequentialModule. */
template<class Archive>
void serialize(Archive &ar, SequentialModule &rhs, unsigned const version);
-/** @brief Serialization save operator of @ref CPUConcatenation. */
+/** @brief Serialization save operator of CPUConcatenation. */
template<class Archive>
void save(Archive &ar, CPUConcatenation const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPUConcatenation. */
+/** @brief Serialization pre-save operator of CPUConcatenation. */
template<class Archive>
void save_construct_data(Archive &ar, CPUConcatenation const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPUConcatenation. */
+/** @brief Serialization load operator of CPUConcatenation. */
template<class Archive>
void load(Archive &ar, CPUConcatenation &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPUConcatenation. */
+/** @brief Serialization pre-load operator of CPUConcatenation. */
template<class Archive>
void save_construct_data(Archive &ar, CPUConcatenation *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(CPUConcatenation)
-/** @brief Serialization save operator of @ref CPUIdentity. */
+/** @brief Serialization save operator of CPUIdentity. */
template<class Archive>
void save(Archive &ar, CPUIdentity const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPUIdentity. */
+/** @brief Serialization pre-save operator of CPUIdentity. */
template<class Archive>
void save_construct_data(Archive &ar, CPUIdentity const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPUIdentity. */
+/** @brief Serialization load operator of CPUIdentity. */
template<class Archive>
void load(Archive &ar, CPUIdentity &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPUIdentity. */
+/** @brief Serialization pre-load operator of CPUIdentity. */
template<class Archive>
void save_construct_data(Archive &ar, CPUIdentity *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(CPUIdentity)
-/** @brief Serialization save operator of @ref CPULogistic. */
+/** @brief Serialization save operator of CPULogistic. */
template<class Archive>
void save(Archive &ar, CPULogistic const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPULogistic. */
+/** @brief Serialization pre-save operator of CPULogistic. */
template<class Archive>
void save_construct_data(Archive &ar, CPULogistic const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPULogistic. */
+/** @brief Serialization load operator of CPULogistic. */
template<class Archive>
void load(Archive &ar, CPULogistic &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPULogistic. */
+/** @brief Serialization pre-load operator of CPULogistic. */
template<class Archive>
void save_construct_data(Archive &ar, CPULogistic *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(CPULogistic)
-/** @brief Serialization save operator of @ref CPUPositiveShrink. */
+/** @brief Serialization save operator of CPUPositiveShrink. */
template<class Archive>
void save(Archive &ar, CPUPositiveShrink const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPUPositiveShrink. */
+/** @brief Serialization pre-save operator of CPUPositiveShrink. */
template<class Archive>
void save_construct_data(Archive &ar, CPUPositiveShrink const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPUPositiveShrink. */
+/** @brief Serialization load operator of CPUPositiveShrink. */
template<class Archive>
void load(Archive &ar, CPUPositiveShrink &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPUPositiveShrink. */
+/** @brief Serialization pre-load operator of CPUPositiveShrink. */
template<class Archive>
void save_construct_data(Archive &ar, CPUPositiveShrink *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(CPUPositiveShrink)
-/** @brief Serialization save operator of @ref CPUTanH. */
+/** @brief Serialization save operator of CPUTanH. */
template<class Archive>
void save(Archive &ar, CPUTanH const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPUTanH. */
+/** @brief Serialization pre-save operator of CPUTanH. */
template<class Archive>
void save_construct_data(Archive &ar, CPUTanH const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPUTanH. */
+/** @brief Serialization load operator of CPUTanH. */
template<class Archive>
void load(Archive &ar, CPUTanH &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPUTanH. */
+/** @brief Serialization pre-load operator of CPUTanH. */
template<class Archive>
void save_construct_data(Archive &ar, CPUTanH *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(CPUTanH)
-/** @brief Serialization save operator of @ref GPUIdentity. */
+/** @brief Serialization save operator of GPUIdentity. */
template<class Archive>
void save(Archive &ar, GPUIdentity const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref GPUIdentity. */
+/** @brief Serialization pre-save operator of GPUIdentity. */
template<class Archive>
void save_construct_data(Archive &ar, GPUIdentity const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref GPUIdentity. */
+/** @brief Serialization load operator of GPUIdentity. */
template<class Archive>
void load(Archive &ar, GPUIdentity &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref GPUIdentity. */
+/** @brief Serialization pre-load operator of GPUIdentity. */
template<class Archive>
void save_construct_data(Archive &ar, GPUIdentity *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(GPUIdentity)
-/** @brief Serialization save operator of @ref GPUPositiveShrink. */
+/** @brief Serialization save operator of GPUPositiveShrink. */
template<class Archive>
void save(Archive &ar, GPUPositiveShrink const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref GPUPositiveShrink. */
+/** @brief Serialization pre-save operator of GPUPositiveShrink. */
template<class Archive>
void save_construct_data(Archive &ar, GPUPositiveShrink const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref GPUPositiveShrink. */
+/** @brief Serialization load operator of GPUPositiveShrink. */
template<class Archive>
void load(Archive &ar, GPUPositiveShrink &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref GPUPositiveShrink. */
+/** @brief Serialization pre-load operator of GPUPositiveShrink. */
template<class Archive>
void save_construct_data(Archive &ar, GPUPositiveShrink *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(GPUPositiveShrink)
-/** @brief Serialization save operator of @ref GPUTanH. */
+/** @brief Serialization save operator of GPUTanH. */
template<class Archive>
void save(Archive &ar, GPUTanH const &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref GPUTanH. */
+/** @brief Serialization pre-save operator of GPUTanH. */
template<class Archive>
void save_construct_data(Archive &ar, GPUTanH const *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref GPUTanH. */
+/** @brief Serialization load operator of GPUTanH. */
template<class Archive>
void load(Archive &ar, GPUTanH &rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref GPUTanH. */
+/** @brief Serialization pre-load operator of GPUTanH. */
template<class Archive>
void save_construct_data(Archive &ar, GPUTanH *rhs, unsigned const version);
BOOST_SERIALIZATION_SPLIT_FREE(GPUTanH)
-/** @brief Serialization load operator of @ref CPUUnique. */
+/** @brief Serialization load operator of CPUUnique. */
template<class Archive>
void serialize(Archive &ar, CPUUnique &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPUUnique. */
+/** @brief Serialization pre-save operator of CPUUnique. */
template<class Archive>
void save_construct_data(Archive &ar, CPUUnique const *rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPUUnique. */
+/** @brief Serialization pre-load operator of CPUUnique. */
template<class Archive>
void save_construct_data(Archive &ar, CPUUnique *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref GPULinear. */
+/** @brief Serialization load operator of GPULinear. */
template<class Archive>
void serialize(Archive &ar, GPULinear &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref GPULinear. */
+/** @brief Serialization pre-save operator of GPULinear. */
template<class Archive>
void save_construct_data(Archive &ar, GPULinear const *rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref GPULinear. */
+/** @brief Serialization pre-load operator of GPULinear. */
template<class Archive>
void save_construct_data(Archive &ar, GPULinear *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPULinear. */
+/** @brief Serialization load operator of CPULinear. */
template<class Archive>
void serialize(Archive &ar, CPULinear &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPULinear. */
+/** @brief Serialization pre-save operator of CPULinear. */
template<class Archive>
void save_construct_data(Archive &ar, CPULinear const *rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPULinear. */
+/** @brief Serialization pre-load operator of CPULinear. */
template<class Archive>
void save_construct_data(Archive &ar, CPULinear *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref GPUUnique. */
+/** @brief Serialization load operator of GPUUnique. */
template<class Archive>
void serialize(Archive &ar, GPUUnique &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref GPUUnique. */
+/** @brief Serialization pre-save operator of GPUUnique. */
template<class Archive>
void save_construct_data(Archive &ar, GPUUnique const *rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref GPUUnique. */
+/** @brief Serialization pre-load operator of GPUUnique. */
template<class Archive>
void save_construct_data(Archive &ar, GPUUnique *rhs, unsigned const version);
-/** @brief Serialization load operator of @ref CPUSparseLinear. */
+/** @brief Serialization load operator of CPUSparseLinear. */
template<class Archive>
void serialize(Archive &ar, CPUSparseLinear &rhs, unsigned const version);
-/** @brief Serialization pre-save operator of @ref CPUSparseLinear. */
+/** @brief Serialization pre-save operator of CPUSparseLinear. */
template<class Archive>
void save_construct_data(Archive &ar, CPUSparseLinear const *rhs, unsigned const version);
-/** @brief Serialization pre-load operator of @ref CPUSparseLinear. */
+/** @brief Serialization pre-load operator of CPUSparseLinear. */
template<class Archive>
void save_construct_data(Archive &ar, CPUSparseLinear *rhs, unsigned const version);
diff --git a/src/supervisor.cpp b/src/supervisor.cpp
@@ -230,7 +230,7 @@ void save_views(std::string const &database_path, std::vector<boost::shared_ptr<
if(err!=SQLITE_OK)
throw std::runtime_error(sqlite3_errmsg(connection.handle));
- /// @fixme Can it be optimised?
+ /// @todo Can it be optimised?
std::stringstream buf;
boost::archive::binary_oarchive oa(buf);
oa << *view;
diff --git a/src/view_ctl.cpp b/src/view_ctl.cpp
@@ -172,7 +172,7 @@ boost::shared_ptr<View> detached_build_view(std::string const &name, std::string
}
void add_view(std::string const &database_path, boost::shared_ptr<View> view){
- /// @fixme Can it be optimised?
+ /// @todo Can it be optimised?
std::stringstream buf;
boost::archive::binary_oarchive oa(buf);
oa << view;
