Commit 8c3ac123 authored by Sebastian Eichelbaum's avatar Sebastian Eichelbaum

[DOC]

* removed some obsolete doxygen options
* fixed most doc warnings
-> remaining warnings are due to bugs in doxygen
parent 41d6e6a9
......@@ -279,22 +279,6 @@ SUBGROUPING = YES
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
#---------------------------------------------------------------------------
......@@ -1411,7 +1395,7 @@ HAVE_DOT = NO
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = FreeSans
# 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.
......
......@@ -279,22 +279,6 @@ SUBGROUPING = YES
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
#---------------------------------------------------------------------------
......@@ -1413,7 +1397,7 @@ HAVE_DOT = YES
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = FreeSans
# 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.
......
......@@ -103,6 +103,8 @@ public:
* Check whether the function exists.
*
* \param name the name of the function
*
* \return true if it exists.
*/
bool existsFunction( const std::string& name ) const;
......
......@@ -260,7 +260,7 @@ namespace WStructuredTextParser
* itself. When querying, you always need to specify the full path. This class can be seen as accessor to the
* \ref WStructuredTextParser::ObjectType tree.
*
* \note The syntax of the parsed files is defined by the parser itself. See \ref WStructuredTextParser::Grammar for details.
* \note The syntax of the parsed files is defined by the parser itself. See WStructuredTextParser::Grammar for details.
* \note This also stores the comments of the parsed file. This allows them to be written again if OW loads a file, modifies it and re-writes
* it.
*/
......
......@@ -100,10 +100,25 @@ public:
*/
boost::shared_ptr< WEEGChannelInfo > getChannelInfo( std::size_t channelID ) const;
/**
* Return the name of the dataset
*
* \return the name
*/
virtual const std::string getName() const;
/**
* Description of dataset.
*
* \return description of dataset
*/
virtual const std::string getDescription() const;
/**
* Get dataset prototype.
*
* \return the prototype
*/
static boost::shared_ptr< WPrototyped > getPrototype();
protected:
......
......@@ -97,7 +97,7 @@ public:
void properties();
/**
*
* Used as callback to mark a change in the ROI
*/
void propertyChanged();
......
......@@ -106,6 +106,12 @@ private:
*/
struct PostponedLoad
{
/**
* Initialize the class and keep track of the lib (and its reference).
*
* \param lib the lib to keep
* \param path the lib path
*/
PostponedLoad( boost::shared_ptr< WSharedLib > lib, boost::filesystem::path path ):
m_lib( lib ),
m_path( path )
......
......@@ -95,6 +95,8 @@ class VisitorVSet: public boost::static_visitor<>
public:
/**
* Create visitor instance and convert it to the given input type
*
* \param fn the filename
*/
explicit VisitorVSet( boost::filesystem::path fn ):
boost::static_visitor<>(),
......
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