From 219871b1dc0e256e58c5df17dd6980b620809cdc Mon Sep 17 00:00:00 2001 From: Marcelo Roberto Jimenez Date: Thu, 12 Jun 2008 03:41:08 +0000 Subject: [PATCH] Doxygen. git-svn-id: https://pupnp.svn.sourceforge.net/svnroot/pupnp/trunk@437 119443c7-1b9e-41f8-b6fc-b9c35fce742c --- upnp/inc/UpnpString.h | 12 ++++++------ upnp/src/api/UpnpString.c | 25 +++++++++++++------------ 2 files changed, 19 insertions(+), 18 deletions(-) diff --git a/upnp/inc/UpnpString.h b/upnp/inc/UpnpString.h index 26097b2..710624b 100644 --- a/upnp/inc/UpnpString.h +++ b/upnp/inc/UpnpString.h @@ -5,19 +5,19 @@ /*! - * \file + * \defgroup UpnpString The UpnpString Class * - * \brief UpnpString object declararion. - * - * This class implements string operations in the UPnP library. + * \brief Implements string operations in the UPnP library. * * \author Marcelo Roberto Jimenez * * \version 1.0 * - * \defgroup UpnpString The UpnpString Class - * * @{ + * + * \file + * + * \brief UpnpString object declarartion. */ diff --git a/upnp/src/api/UpnpString.c b/upnp/src/api/UpnpString.c index 5305f3b..197ece9 100644 --- a/upnp/src/api/UpnpString.c +++ b/upnp/src/api/UpnpString.c @@ -1,12 +1,20 @@ /*! + * \addtogroup UpnpString + * + * Due to its heavy use, this class is coded for efficiency, not for beauty. + * Do not use this as example to other classes. Please take a look at any + * other one. + * + * \todo Always alloc a minimum size like 64 bytes or so and when shrinking + * do not perform a new memory allocation. + * + * @{ + * * \file * * \brief UpnpString object implementation. - * - * \author Marcelo Roberto Jimenez - * */ @@ -21,18 +29,9 @@ /*! - * \ingroup UpnpString - * * \brief Internal implementation of the class UpnpString. * * \internal - * - * Due to its heavy use, this class is coded for efficiency, not for beauty. - * Do not use this as example to other classes. Please take a look at any - * other one. - * - * \todo Always alloc a minimum size like 64 bytes or so and when shrinking - * do not perform a new memory allocation. */ struct SUpnpString { @@ -151,3 +150,5 @@ void UpnpString_clear(UpnpString *p) ((struct SUpnpString *)p)->m_string[0] = 0; } +/* @} UpnpString */ +