fix SQLChannel documentation

This commit is contained in:
Günter Obiltschnig
2018-09-27 11:27:17 +02:00
parent 0ca1a0a84e
commit 5669a1ae3b

View File

@@ -71,16 +71,16 @@ public:
const std::string& name = "-"); const std::string& name = "-");
/// Creates a SQLChannel with the given connector, connect string, timeout, table and name. /// Creates a SQLChannel with the given connector, connect string, timeout, table and name.
/// The connector must be already registered. /// The connector must be already registered.
void open(); void open();
/// Opens the SQLChannel. /// Opens the SQLChannel.
void close(); void close();
/// Closes the SQLChannel. /// Closes the SQLChannel.
void log(const Message& msg); void log(const Message& msg);
/// Sends the message's text to the syslog service. /// Sends the message's text to the syslog service.
void setProperty(const std::string& name, const std::string& value); void setProperty(const std::string& name, const std::string& value);
/// Sets the property with the given value. /// Sets the property with the given value.
/// ///
@@ -88,9 +88,7 @@ public:
/// * name: The name used to identify the source of log messages. /// * name: The name used to identify the source of log messages.
/// Defaults to "-". /// Defaults to "-".
/// ///
/// * target: The target data storage type ("SQLite", "ODBC", ...). /// * connector: The target data storage connector name ("SQLite", "ODBC", ...).
///
/// * connector: The target data storage connector name.
/// ///
/// * connect: The target data storage connection string. /// * connect: The target data storage connection string.
/// ///
@@ -177,7 +175,7 @@ private:
int _timeout; int _timeout;
bool _throw; bool _throw;
bool _async; bool _async;
// members for log entry cache (needed for async mode) // members for log entry cache (needed for async mode)
std::string _source; std::string _source;
long _pid; long _pid;
@@ -199,7 +197,7 @@ inline std::size_t SQLChannel::wait()
{ {
if (_async && _pLogStatement) if (_async && _pLogStatement)
return _pLogStatement->wait(_timeout); return _pLogStatement->wait(_timeout);
return 0; return 0;
} }