From a127c8827a0733861366bfe1c0ca2fe7ccfac114 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Sun, 4 Apr 2010 15:13:15 +0200 Subject: Fixed the documentation of log.c --- include/libssh/libssh.h | 12 +++++++----- libssh/log.c | 14 ++++++++------ 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/include/libssh/libssh.h b/include/libssh/libssh.h index 13362a75..462be335 100644 --- a/include/libssh/libssh.h +++ b/include/libssh/libssh.h @@ -225,12 +225,15 @@ enum ssh_error_types_e { #define SSH_AGAIN -2 /* The nonblocking call must be repeated */ #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 { /** No logging at all */ @@ -248,8 +251,7 @@ enum { */ SSH_LOG_FUNCTIONS }; -/** @} - */ +/* @} */ enum ssh_options_e { SSH_OPTIONS_HOST, diff --git a/libssh/log.c b/libssh/log.c index 0dab4aef..b8a0dbcf 100644 --- a/libssh/log.c +++ b/libssh/log.c @@ -29,12 +29,13 @@ #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. @@ -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: */ -- cgit v1.2.3