fix documentation of SQLChannel class

This commit is contained in:
Günter Obiltschnig 2018-09-27 11:25:47 +02:00
parent bd0b767502
commit 62bbeaec8f

View File

@ -49,11 +49,11 @@ class Data_API SQLChannel: public Poco::Channel
/// DateTime DATE)"
///
/// The table name is configurable through "table" property.
/// Other than DateTime filed name used for optiona time-based archiving purposes, currently the
/// Other than DateTime filed name used for optional time-based archiving purposes, currently the
/// field names are not mandated. However, it is recomended to use names as specified above.
///
/// To provide as non-intrusive operation as possbile, the log entries are cached and
/// inserted into the target database asynchronously by default . The blocking, however, will occur
/// inserted into the target database asynchronously by default. The blocking, however, will occur
/// before the next entry insertion with default timeout of 1 second. The default settings can be
/// overriden (see async, timeout and throw properties for details).
/// If throw property is false, insertion timeouts are ignored, otherwise a TimeoutException is thrown.
@ -77,7 +77,7 @@ public:
/// Closes the SQLChannel.
void log(const Message& msg);
/// Sends the message's text to the syslog service.
/// Writes the log message to the database.
void setProperty(const std::string& name, const std::string& value);
/// Sets the property with the given value.
@ -86,8 +86,6 @@ public:
/// * name: The name used to identify the source of log messages.
/// Defaults to "-".
///
/// * target: The target data storage type ("SQLite", "ODBC", ...).
///
/// * connector: The target data storage connector name.
///
/// * connect: The target data storage connection string.