Doxygen source annotation added

2015-10-10 19:54:30 +02:00
parent 0ff5587137
commit 6dbd4151b7
8 changed files with 850 additions and 215 deletions
--- a/include/atleap.h
+++ b/include/atleap.h
@@ -26,9 +26,21 @@ namespace ATL
 {
    namespace EAP
    {
+        ///
+        /// \defgroup ATLEAPAPI Extensible Authentication Protocol API
+        /// Integrates ATL classes with Microsoft EAP API
+        ///
+        /// @{
+
+        ///
+        /// EAP_ATTRIBUTE wrapper class
+        ///
        class CEAPAttribute : public EAP_ATTRIBUTE
        {
        public:
+            ///
+            /// Initializes a new EAP attribute set to eatReserved.
+            ///
            CEAPAttribute()
            {
                eaType   = eatReserved;
@@ -36,11 +48,16 @@ namespace ATL
                pValue   = NULL;
            }

+            ///
+            /// Destroys the EAP attribute.
+            ///
            ~CEAPAttribute()
            {
                if (pValue)
                    delete pValue;
            }
        };
+
+        /// @}
    }
 }