diff --git a/Doxyfile b/Doxyfile index 2cfba56..25d7caf 100644 --- a/Doxyfile +++ b/Doxyfile @@ -322,7 +322,7 @@ INLINE_INFO = YES # alphabetically by member name. If set to NO the members will appear in # declaration order. -SORT_MEMBER_DOCS = NO +SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically diff --git a/upnp/inc/upnp.h b/upnp/inc/upnp.h index 5cd407b..5ce5329 100644 --- a/upnp/inc/upnp.h +++ b/upnp/inc/upnp.h @@ -1119,7 +1119,7 @@ EXPORT_SPEC int UpnpRegisterRootDevice3( */ EXPORT_SPEC int UpnpUnRegisterRootDevice( /*! [in] The handle of the root device instance to unregister. */ - UpnpDevice_Handle); + UpnpDevice_Handle Hnd); /*! @@ -1553,16 +1553,18 @@ EXPORT_SPEC int UpnpSendActionExAsync( */ -/*! \b UpnpAcceptSubscription accepts a subscription request and sends - * out the current state of the eventable variables for a service. - * The device application should call this function when it receives a - * \c UPNP_EVENT_SUBSCRIPTION_REQUEST callback. This function is - * synchronous and generates no callbacks. +/*! + * \brief Accepts a subscription request and sends out the current state of the + * eventable variables for a service. * - * \b UpnpAcceptSubscription can be called during the execution of - * a callback function. + * The device application should call this function when it receives a + * \c UPNP_EVENT_SUBSCRIPTION_REQUEST callback. * - * \return [int] An integer representing one of the following: + * This function is synchronous and generates no callbacks. + * + * This function can be called during the execution of a callback function. + * + * \return An integer representing one of the following: * \li \c UPNP_E_SUCCESS: The operation completed successfully. * \li \c UPNP_E_INVALID_HANDLE: The handle is not a valid device * handle. @@ -1594,13 +1596,12 @@ EXPORT_SPEC int UpnpAcceptSubscription( /*! - * \brief Similar to \b UpnpAcceptSubscription except that it takes a DOM + * \brief Similar to \b UpnpAcceptSubscription() except that it takes a DOM * document for the variables to event rather than an array of strings. * * This function is sychronous and generates no callbacks. * - * \b UpnpAcceptSubscriptionExt can be called during the execution of - * a callback function. + * This function can be called during the execution of a callback function. * * \return An integer representing one of the following: * \li \c UPNP_E_SUCCESS: The operation completed successfully. @@ -1637,8 +1638,8 @@ EXPORT_SPEC int UpnpAcceptSubscriptionExt( * * This function is synchronous and generates no callbacks. * - * \b UpnpNotify may be called during a callback function to send out - * a notification. + * This function may be called during a callback function to send out a + * notification. * * \return An integer representing one of the following: * \li \c UPNP_E_SUCCESS: The operation completed successfully. @@ -1673,8 +1674,8 @@ EXPORT_SPEC int UpnpNotify( * * This function is synchronous and generates no callbacks. * - * \b UpnpNotifyExt may be called during a callback function to send out - * a notification. + * This function may be called during a callback function to send out a + * notification. * * \return An integer representing one of the following: * \li \c UPNP_E_SUCCESS: The operation completed successfully. diff --git a/upnp/inc/upnptools.h b/upnp/inc/upnptools.h index 817c836..942ad44 100644 --- a/upnp/inc/upnptools.h +++ b/upnp/inc/upnptools.h @@ -37,12 +37,13 @@ /*! * \file * - * \defgroup UPnPTools Optional Tool APIs + * \defgroup UPnPTools Optional Tool API * - * The Linux SDK for UPnP Devices contains some additional, optional - * utility APIs that can be helpful in writing applications using the - * SDK. These additional APIs can be compiled out in order to save code - * size in the SDK. Refer to the README for details. + * \brief Additional, optional utility API that can be helpful in writing + * applications. + * + * This additional API can be compiled out in order to save code size in the + * library. Refer to the file README for details. * * @{ */ diff --git a/upnp/src/api/upnpapi.c b/upnp/src/api/upnpapi.c index c49b91b..7446e7d 100644 --- a/upnp/src/api/upnpapi.c +++ b/upnp/src/api/upnpapi.c @@ -813,7 +813,7 @@ exit_function: return retVal; } -#endif // INCLUDE_DEVICE_APIS +#endif /* INCLUDE_DEVICE_APIS */ #ifdef INCLUDE_DEVICE_APIS @@ -822,8 +822,6 @@ int UpnpUnRegisterRootDevice(UpnpDevice_Handle Hnd) int retVal = 0; struct Handle_Info *HInfo = NULL; - // struct Handle_Info *info=NULL; - if (UpnpSdkInit != 1) { return UPNP_E_FINISH; }