Fixed the documentation of log.c

This commit is contained in:
Andreas Schneider
2010-04-04 15:13:15 +02:00
parent dcb5a81735
commit a127c8827a
2 changed files with 15 additions and 11 deletions

View File

@@ -225,12 +225,15 @@ enum ssh_error_types_e {
#define SSH_AGAIN -2 /* The nonblocking call must be repeated */ #define SSH_AGAIN -2 /* The nonblocking call must be repeated */
#define SSH_EOF -127 /* We have already a eof */ #define SSH_EOF -127 /* We have already a eof */
/** \addtogroup ssh_log /**
* @addtogroup libssh_log
*
* @{ * @{
*/ */
/** \brief Verbosity level for logging and help to debugging
*/
/**
* @brief Verbosity level for logging and help to debugging
*/
enum { enum {
/** No logging at all /** No logging at all
*/ */
@@ -248,8 +251,7 @@ enum {
*/ */
SSH_LOG_FUNCTIONS SSH_LOG_FUNCTIONS
}; };
/** @} /* @} */
*/
enum ssh_options_e { enum ssh_options_e {
SSH_OPTIONS_HOST, SSH_OPTIONS_HOST,

View File

@@ -29,12 +29,13 @@
#include "libssh/session.h" #include "libssh/session.h"
/** /**
* @defgroup ssh_log SSH Logging * @defgroup libssh_log The SSH logging functions.
* @ingroup libssh
* *
* @brief Logging functions for debugging and problem resolving * Logging functions for debugging and problem resolving.
*
* @{
*/ */
/** \addtogroup ssh_log
* @{ */
/** /**
* @brief Log a SSH event. * @brief Log a SSH event.
@@ -76,5 +77,6 @@ void ssh_log(ssh_session session, int verbosity, const char *format, ...) {
} }
} }
/** @} */ /* @} */
/* vim: set ts=2 sw=2 et cindent: */
/* vim: set ts=4 sw=4 et cindent: */