Doxygen documentation update

Doxyfile

@@ -791,9 +791,11 @@ RECURSIVE              = YES
 
 EXCLUDE                = \
 	lib\EAPBase_UI\res \
+	lib\EapHost_UI\res \
 	lib\TLS_UI\res \
 	lib\TTLS_UI\res \
-	lib\WinStd
+	lib\WinStd \
+	lib\wxExtend
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

lib/EAPBase/include/Config.h

@@ -195,7 +195,7 @@ namespace eap
         module &m_module;   ///< EAP module
 
     protected:
-        static const winstd::bstr namespace_eapmetadata;
+        static const winstd::bstr namespace_eapmetadata;    ///< Reusable BSTR containing "urn:ietf:params:xml:ns:yang:ietf-eap-metadata"
     };
 
 
@@ -558,6 +558,9 @@ namespace eap
     class config_connection : public config
     {
     public:
+        ///
+        /// List of configuration providers
+        ///
         typedef std::list<eap::config_provider> provider_list;
 
     public:

lib/EAPBase/include/EAP.h

@@ -486,6 +486,9 @@ namespace eap
 {
     struct cursor_out
     {
+        ///
+        /// Pointer to output data type
+        ///
         typedef unsigned char *ptr_type;
 
         ptr_type ptr;       ///< Pointer to first data unwritten
@@ -495,6 +498,9 @@ namespace eap
 
     struct cursor_in
     {
+        ///
+        /// Pointer to input data type
+        ///
         typedef const unsigned char *ptr_type;
 
         ptr_type ptr;       ///< Pointer to first data unread

lib/EAPBase_UI/include/EAP_UI.h

@@ -33,7 +33,7 @@
 class wxEAPBannerPanel;
 
 ///
-/// EAP top-most configuration dialog
+/// EAP top-most configuration dialog template
 ///
 template <class _wxT> class wxEAPConfigDialog;
 
@@ -429,13 +429,13 @@ protected:
     /// \endcond
 
 protected:
-    wxStaticText *m_provider_notice;
-    wxStaticText *m_help_web_label;
-    wxHyperlinkCtrl *m_help_web_value;
-    wxStaticText *m_help_email_label;
-    wxHyperlinkCtrl *m_help_email_value;
-    wxStaticText *m_help_phone_label;
-    wxHyperlinkCtrl *m_help_phone_value;
+    wxStaticText *m_provider_notice;        ///< Identity provider notice
+    wxStaticText *m_help_web_label;         ///< Helpdesk URL label
+    wxHyperlinkCtrl *m_help_web_value;      ///< Helpdesk URL
+    wxStaticText *m_help_email_label;       ///< Helpdesk e-mail label
+    wxHyperlinkCtrl *m_help_email_value;    ///< Helpdesk e-mail
+    wxStaticText *m_help_phone_label;       ///< Helpdesk phone number label
+    wxHyperlinkCtrl *m_help_phone_value;    ///< Helpdesk phone number
 };
 
 
@@ -477,8 +477,21 @@ public:
     virtual ~wxEAPConfigWindow();
 
 public:
-    inline eap::config_provider& GetProvider() const { return m_prov; }
-    inline eap::config_method  & GetConfig  () const { return m_cfg ; }
+    ///
+    /// Returns reference to configuration provider
+    ///
+    inline eap::config_provider& GetProvider() const
+    {
+        return m_prov;
+    }
+
+    ///
+    /// Returns reference to method configuration
+    ///
+    inline eap::config_method& GetConfig() const
+    {
+        return m_cfg;
+    }
 
 protected:
     /// \cond internal
@@ -848,12 +861,20 @@ public:
             m_remember = NULL;
     }
 
+    ///
+    /// (Un)checks "Remember credentials" checkbox
+    ///
+    /// \param[in] val  If \c true, checkbox is checked; otherwise cleared
+    ///
     virtual void SetRemember(bool val)
     {
         if (m_remember)
             m_remember->SetValue(val);
     }
 
+    ///
+    /// Returns \c true if "Remember credentials" checkbox is checked
+    ///
     virtual bool GetRemember() const
     {
         return m_remember ?
@@ -1003,28 +1024,58 @@ namespace eap
     class monitor_ui
     {
     public:
+        ///
+        /// Constructs a UI monitor
+        ///
         monitor_ui(_In_ HINSTANCE module, _In_ const GUID &guid);
+
+        ///
+        /// Destructs the UI monitor
+        ///
         virtual ~monitor_ui();
 
+        ///
+        /// Sets pop-up window handle
+        ///
+        /// \param[in] hwnd  Handle of window to set as a new pop-up
+        ///
         void set_popup(_In_ HWND hwnd);
+
+        ///
+        /// Notifies all slaves waiting for this master and send them result data
+        ///
+        /// \param[in] data  Pointer to result data
+        /// \param[in] size  \p data size in bytes
+        ///
         void release_slaves(_In_bytecount_(size) const void *data, _In_ size_t size) const;
 
+        ///
+        /// Returns true if this is a master
+        ///
         inline bool is_master() const
         {
             return m_is_master;
         }
 
+        ///
+        /// Returns true if this is a slave
+        ///
         inline bool is_slave() const
         {
             return !is_master();
         }
 
+        ///
+        /// Returns the data master send
+        ///
         inline const std::vector<unsigned char>& master_data() const
         {
             return m_data;
         }
 
     protected:
+        /// \cond internal
+
         virtual LRESULT winproc(
             _In_ UINT   msg,
             _In_ WPARAM wparam,
@@ -1036,6 +1087,8 @@ namespace eap
             _In_ WPARAM wparam,
             _In_ LPARAM lparam);
 
+        /// \endcond
+
     protected:
         bool m_is_master;                   ///< Is this monitor master?
         HWND m_hwnd;                        ///< Message window handle

lib/EAPBase_UI/include/wxEAP_UIBase.h

@@ -43,6 +43,15 @@ public:
     {
     }
 
+    ///
+    /// (Un)checks "Remember credentials" checkbox
+    ///
+    /// \param[in] val  If \c true, checkbox is checked; otherwise cleared
+    ///
     virtual void SetRemember(bool val) = 0;
+
+    ///
+    /// Returns \c true if "Remember credentials" checkbox is checked
+    ///
     virtual bool GetRemember() const = 0;
 };

lib/EapHost/include/Config.h

@@ -168,7 +168,9 @@ namespace eap
         }
 
     protected:
+        /// \cond internal
         void update_type();
+        /// \endcond
 
     protected:
         EAP_METHOD_TYPE m_type;     ///< EapHost method type: (EAP type, vendor ID, vendor type, author ID) tuple