From: Martin Willi Date: Tue, 8 Feb 2011 09:18:42 +0000 (+0100) Subject: Fixed doxygen groups in libcharon tnc subtree X-Git-Tag: 4.5.1~39 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=11a6f299444d621a697f1051ff9ed9e6ccacbaca;p=thirdparty%2Fstrongswan.git Fixed doxygen groups in libcharon tnc subtree --- diff --git a/src/libcharon/tnc/imc/imc.h b/src/libcharon/tnc/imc/imc.h index affaadd8bc..fe8f25b0f5 100644 --- a/src/libcharon/tnc/imc/imc.h +++ b/src/libcharon/tnc/imc/imc.h @@ -15,7 +15,10 @@ /** * @defgroup imc imc - * @{ @ingroup libcharon + * @ingroup tnc + * + * @defgroup imct imc + * @{ @ingroup imc */ #ifndef IMC_H_ diff --git a/src/libcharon/tnc/imv/imv.h b/src/libcharon/tnc/imv/imv.h index c832a1590f..26874ab0ba 100644 --- a/src/libcharon/tnc/imv/imv.h +++ b/src/libcharon/tnc/imv/imv.h @@ -15,7 +15,10 @@ /** * @defgroup imv imv - * @{ @ingroup libcharon + * @ingroup tnc + * + * @defgroup imvt imv + * @{ @ingroup imv */ #ifndef IMV_H_ diff --git a/src/libcharon/tnc/imv/imv_recommendations.h b/src/libcharon/tnc/imv/imv_recommendations.h index 5451838373..3a6e25c9f9 100644 --- a/src/libcharon/tnc/imv/imv_recommendations.h +++ b/src/libcharon/tnc/imv/imv_recommendations.h @@ -15,7 +15,7 @@ /** * @defgroup imv_recommendations imv_recommendations - * @{ @ingroup libcharon + * @{ @ingroup imv */ #ifndef IMV_RECOMMENDATIONS_H_ diff --git a/src/libcharon/tnc/tnccs/tnccs.h b/src/libcharon/tnc/tnccs/tnccs.h index 040a70b83b..c5d6f5ef0d 100644 --- a/src/libcharon/tnc/tnccs/tnccs.h +++ b/src/libcharon/tnc/tnccs/tnccs.h @@ -15,7 +15,10 @@ /** * @defgroup tnccs tnccs - * @{ @ingroup libcharon + * @ingroup tnc + * + * @defgroup tnccst tnccs + * @{ @ingroup tnccs */ #ifndef TNCCS_H_ diff --git a/src/libcharon/tnc/tncif.h b/src/libcharon/tnc/tncif.h index 0c55cc0a9a..99441a9a92 100644 --- a/src/libcharon/tnc/tncif.h +++ b/src/libcharon/tnc/tncif.h @@ -14,31 +14,31 @@ * notice, this list of conditions and the following disclaimer. * - Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the + * the documentation and/or other materials provided with the * distribution. * - Neither the name of the Trusted Computing Group nor the names of - * its contributors may be used to endorse or promote products - * derived from this software without specific prior written + * its contributors may be used to endorse or promote products + * derived from this software without specific prior written * permission. * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE - * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, - * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; - * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN - * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - * Contact the Trusted Computing Group at - * admin@trustedcomputinggroup.org for information on specification + * Contact the Trusted Computing Group at + * admin@trustedcomputinggroup.org for information on specification * licensing through membership agreements. * - * Any marks and brands contained herein are the property of their + * Any marks and brands contained herein are the property of their * respective owners. * * Trusted Network Connect IF-IMC/IF-IMV API version 1.00 Revision 3 @@ -47,11 +47,17 @@ * extracted from tncifimc.h and tncifimv.h * Feb 12, 2007 */ -#ifndef _TNCIF_H -#define _TNCIF_H -#ifdef __cplusplus -extern "C" { -#endif + +/** + * @defgroup tnc tnc + * @ingroup libcharon + * + * @defgroup tncif tncif + * @{ @ingroup tnc + */ + +#ifndef TNCIF_H_ +#define TNCIF_H_ /* Basic Types */ typedef unsigned long TNC_UInt32; @@ -97,7 +103,4 @@ typedef TNC_UInt32 TNC_Result; /* Message Subtype Values */ #define TNC_SUBTYPE_ANY ((TNC_MessageSubtype) 0xff) -#ifdef __cplusplus -} -#endif -#endif +#endif /** TNCIF_H_ @}*/ diff --git a/src/libcharon/tnc/tncifimc.h b/src/libcharon/tnc/tncifimc.h index b7be356a0a..c6ddabd454 100644 --- a/src/libcharon/tnc/tncifimc.h +++ b/src/libcharon/tnc/tncifimc.h @@ -14,51 +14,42 @@ * notice, this list of conditions and the following disclaimer. * - Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the + * the documentation and/or other materials provided with the * distribution. * - Neither the name of the Trusted Computing Group nor the names of - * its contributors may be used to endorse or promote products - * derived from this software without specific prior written + * its contributors may be used to endorse or promote products + * derived from this software without specific prior written * permission. * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE - * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, - * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; - * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN - * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - * Contact the Trusted Computing Group at - * admin@trustedcomputinggroup.org for information on specification + * Contact the Trusted Computing Group at + * admin@trustedcomputinggroup.org for information on specification * licensing through membership agreements. * - * Any marks and brands contained herein are the property of their + * Any marks and brands contained herein are the property of their * respective owners. * */ -#ifndef _TNCIFIMC_H -#define _TNCIFIMC_H - -#ifdef __cplusplus -extern "C" { -#endif +/** + * @defgroup tncifimc tncifimc + * @{ @ingroup tnc + */ -#ifdef WIN32 -#ifdef TNC_IMC_EXPORTS -#define TNC_IMC_API __declspec(dllexport) -#else -#define TNC_IMC_API __declspec(dllimport) -#endif -#else -#define TNC_IMC_API -#endif +#ifndef TNCIFIMC_H_ +#define TNCIFIMC_H_ #include "tncif.h" @@ -129,36 +120,36 @@ typedef TNC_Result (*TNC_IMC_ProvideBindFunctionPointer)( /* IMC Functions */ -TNC_IMC_API TNC_Result TNC_IMC_Initialize( +TNC_Result TNC_IMC_Initialize( /*in*/ TNC_IMCID imcID, /*in*/ TNC_Version minVersion, /*in*/ TNC_Version maxVersion, /*out*/ TNC_Version *pOutActualVersion); -TNC_IMC_API TNC_Result TNC_IMC_NotifyConnectionChange( +TNC_Result TNC_IMC_NotifyConnectionChange( /*in*/ TNC_IMCID imcID, /*in*/ TNC_ConnectionID connectionID, /*in*/ TNC_ConnectionState newState); -TNC_IMC_API TNC_Result TNC_IMC_BeginHandshake( +TNC_Result TNC_IMC_BeginHandshake( /*in*/ TNC_IMCID imcID, /*in*/ TNC_ConnectionID connectionID); -TNC_IMC_API TNC_Result TNC_IMC_ReceiveMessage( +TNC_Result TNC_IMC_ReceiveMessage( /*in*/ TNC_IMCID imcID, /*in*/ TNC_ConnectionID connectionID, /*in*/ TNC_BufferReference messageBuffer, /*in*/ TNC_UInt32 messageLength, /*in*/ TNC_MessageType messageType); -TNC_IMC_API TNC_Result TNC_IMC_BatchEnding( +TNC_Result TNC_IMC_BatchEnding( /*in*/ TNC_IMCID imcID, /*in*/ TNC_ConnectionID connectionID); -TNC_IMC_API TNC_Result TNC_IMC_Terminate( +TNC_Result TNC_IMC_Terminate( /*in*/ TNC_IMCID imcID); -TNC_IMC_API TNC_Result TNC_IMC_ProvideBindFunction( +TNC_Result TNC_IMC_ProvideBindFunction( /*in*/ TNC_IMCID imcID, /*in*/ TNC_TNCC_BindFunctionPointer bindFunction); @@ -186,8 +177,4 @@ TNC_Result TNC_TNCC_BindFunction( /*in*/ char *functionName, /*out*/ void **pOutfunctionPointer); -#ifdef __cplusplus -} -#endif - -#endif +#endif /** TNCIFIMC_H_ @}*/ diff --git a/src/libcharon/tnc/tncifimv.h b/src/libcharon/tnc/tncifimv.h index 251865e57c..3e51824f89 100644 --- a/src/libcharon/tnc/tncifimv.h +++ b/src/libcharon/tnc/tncifimv.h @@ -14,50 +14,41 @@ * notice, this list of conditions and the following disclaimer. * - Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the + * the documentation and/or other materials provided with the * distribution. * - Neither the name of the Trusted Computing Group nor the names of - * its contributors may be used to endorse or promote products - * derived from this software without specific prior written + * its contributors may be used to endorse or promote products + * derived from this software without specific prior written * permission. * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE - * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, - * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; - * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN - * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * - * Contact the Trusted Computing Group at - * admin@trustedcomputinggroup.org for information on specification + * Contact the Trusted Computing Group at + * admin@trustedcomputinggroup.org for information on specification * licensing through membership agreements. * - * Any marks and brands contained herein are the property of their + * Any marks and brands contained herein are the property of their * respective owners. */ -#ifndef _TNCIFIMV_H -#define _TNCIFIMV_H - -#ifdef __cplusplus -extern "C" { -#endif +/** + * @defgroup tncifimv tncifimv + * @{ @ingroup tnc + */ -#ifdef WIN32 -#ifdef TNC_IMV_EXPORTS -#define TNC_IMV_API __declspec(dllexport) -#else -#define TNC_IMV_API __declspec(dllimport) -#endif -#else -#define TNC_IMV_API -#endif +#ifndef TNCIFIMV_H_ +#define TNCIFIMV_H_ #include "tncif.h" @@ -171,36 +162,36 @@ typedef TNC_Result (*TNC_IMV_ProvideBindFunctionPointer)( /* IMV Functions */ -TNC_IMV_API TNC_Result TNC_IMV_Initialize( +TNC_Result TNC_IMV_Initialize( /*in*/ TNC_IMVID imvID, /*in*/ TNC_Version minVersion, /*in*/ TNC_Version maxVersion, /*in*/ TNC_Version *pOutActualVersion); -TNC_IMV_API TNC_Result TNC_IMV_NotifyConnectionChange( +TNC_Result TNC_IMV_NotifyConnectionChange( /*in*/ TNC_IMVID imvID, /*in*/ TNC_ConnectionID connectionID, /*in*/ TNC_ConnectionState newState); -TNC_IMV_API TNC_Result TNC_IMV_ReceiveMessage( +TNC_Result TNC_IMV_ReceiveMessage( /*in*/ TNC_IMVID imvID, /*in*/ TNC_ConnectionID connectionID, /*in*/ TNC_BufferReference messageBuffer, /*in*/ TNC_UInt32 messageLength, /*in*/ TNC_MessageType messageType); -TNC_IMV_API TNC_Result TNC_IMV_SolicitRecommendation( +TNC_Result TNC_IMV_SolicitRecommendation( /*in*/ TNC_IMVID imvID, /*in*/ TNC_ConnectionID connectionID); -TNC_IMV_API TNC_Result TNC_IMV_BatchEnding( +TNC_Result TNC_IMV_BatchEnding( /*in*/ TNC_IMVID imvID, /*in*/ TNC_ConnectionID connectionID); -TNC_IMV_API TNC_Result TNC_IMV_Terminate( +TNC_Result TNC_IMV_Terminate( /*in*/ TNC_IMVID imvID); -TNC_IMV_API TNC_Result TNC_IMV_ProvideBindFunction( +TNC_Result TNC_IMV_ProvideBindFunction( /*in*/ TNC_IMVID imvID, /*in*/ TNC_TNCS_BindFunctionPointer bindFunction); @@ -249,8 +240,4 @@ TNC_Result TNC_TNCS_BindFunction( /*in*/ char *functionName, /*in*/ void **pOutfunctionPointer); -#ifdef __cplusplus -} -#endif - -#endif +#endif /** TNCIFIMV_H_ @}*/ diff --git a/src/libcharon/tnc/tncifimv_names.h b/src/libcharon/tnc/tncifimv_names.h index a01d4c767d..249304fa87 100644 --- a/src/libcharon/tnc/tncifimv_names.h +++ b/src/libcharon/tnc/tncifimv_names.h @@ -15,7 +15,7 @@ /** * @defgroup tncifimv_names tncifimv_names - * @{ @ingroup libcharon + * @{ @ingroup tnc */ #ifndef TNCIFIMV_NAMES_H_