From 2711425677b438e96c277da7503030dbeafdf065 Mon Sep 17 00:00:00 2001 From: Simon Rozman Date: Fri, 5 Aug 2016 15:52:27 +0200 Subject: [PATCH] Documentation update --- lib/EAPBase/include/Credentials.h | 8 ++++++++ lib/EAPBase/include/Module.h | 4 ++++ lib/EAPBase_UI/include/Module.h | 10 +++++++++- lib/TLS/include/Credentials.h | 4 ++++ lib/TTLS/include/Credentials.h | 4 ++++ lib/TTLS/include/Module.h | 4 ++++ lib/TTLS_UI/include/Module.h | 10 +++++++++- 7 files changed, 42 insertions(+), 2 deletions(-) diff --git a/lib/EAPBase/include/Credentials.h b/lib/EAPBase/include/Credentials.h index ee2809d..74d56c2 100644 --- a/lib/EAPBase/include/Credentials.h +++ b/lib/EAPBase/include/Credentials.h @@ -102,6 +102,10 @@ namespace eap /// /// Test credentials if blank /// + /// \returns + /// - \c true if blank + /// - \c false otherwise + /// virtual bool empty() const; /// \name XML configuration management @@ -247,6 +251,10 @@ namespace eap /// /// Test credentials if blank /// + /// \returns + /// - \c true if blank + /// - \c false otherwise + /// virtual bool empty() const; /// \name XML configuration management diff --git a/lib/EAPBase/include/Module.h b/lib/EAPBase/include/Module.h index 3acaf61..b749730 100644 --- a/lib/EAPBase/include/Module.h +++ b/lib/EAPBase/include/Module.h @@ -731,6 +731,10 @@ namespace eap /// /// \sa [EapPeerCredentialsXml2Blob function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363603.aspx) /// + /// \returns + /// - \c true if succeeded + /// - \c false otherwise. See \p ppEapError for details. + /// virtual bool credentials_xml2blob( _In_ DWORD dwFlags, _In_ IXMLDOMNode *pConfigRoot, diff --git a/lib/EAPBase_UI/include/Module.h b/lib/EAPBase_UI/include/Module.h index a26091a..d6c05a2 100644 --- a/lib/EAPBase_UI/include/Module.h +++ b/lib/EAPBase_UI/include/Module.h @@ -50,6 +50,10 @@ namespace eap /// /// \sa [EapPeerConfigXml2Blob function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363602.aspx) /// + /// \returns + /// - \c true if succeeded + /// - \c false otherwise. See \p ppEapError for details. + /// virtual bool config_xml2blob( _In_ DWORD dwFlags, _In_ IXMLDOMNode *pConfigRoot, @@ -60,10 +64,14 @@ namespace eap /// /// Converts the configuration BLOB to XML. /// - /// The configuration BLOB is returned in the ppConnectionDataOut parameter of the EapPeerInvokeConfigUI function. + /// The configuration BLOB is returned in the `ppConnectionDataOut` parameter of the `EapPeerInvokeConfigUI` function. /// /// \sa [EapPeerConfigBlob2Xml function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363601.aspx) /// + /// \returns + /// - \c true if succeeded + /// - \c false otherwise. See \p ppEapError for details. + /// virtual bool config_blob2xml( _In_ DWORD dwFlags, _In_count_(dwConnectionDataSize) const BYTE *pConnectionData, diff --git a/lib/TLS/include/Credentials.h b/lib/TLS/include/Credentials.h index 38e1804..b0025ec 100644 --- a/lib/TLS/include/Credentials.h +++ b/lib/TLS/include/Credentials.h @@ -97,6 +97,10 @@ namespace eap /// /// Test credentials if blank /// + /// \returns + /// - \c true if blank + /// - \c false otherwise + /// virtual bool empty() const; /// \name XML credentials management diff --git a/lib/TTLS/include/Credentials.h b/lib/TTLS/include/Credentials.h index 388abea..a284fbe 100644 --- a/lib/TTLS/include/Credentials.h +++ b/lib/TTLS/include/Credentials.h @@ -93,6 +93,10 @@ namespace eap /// /// Test credentials if blank /// + /// \returns + /// - \c true if blank + /// - \c false otherwise + /// virtual bool empty() const; /// \name XML credentials management diff --git a/lib/TTLS/include/Module.h b/lib/TTLS/include/Module.h index 18f4229..ab241ad 100644 --- a/lib/TTLS/include/Module.h +++ b/lib/TTLS/include/Module.h @@ -117,6 +117,10 @@ namespace eap /// /// \sa [EapPeerCredentialsXml2Blob function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363603.aspx) /// + /// \returns + /// - \c true if succeeded + /// - \c false otherwise. See \p ppEapError for details. + /// virtual bool credentials_xml2blob( _In_ DWORD dwFlags, _In_ IXMLDOMNode *pConfigRoot, diff --git a/lib/TTLS_UI/include/Module.h b/lib/TTLS_UI/include/Module.h index 637fa88..c0c8424 100644 --- a/lib/TTLS_UI/include/Module.h +++ b/lib/TTLS_UI/include/Module.h @@ -53,6 +53,10 @@ namespace eap /// /// \sa [EapPeerConfigXml2Blob function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363602.aspx) /// + /// \returns + /// - \c true if succeeded + /// - \c false otherwise. See \p ppEapError for details. + /// virtual bool config_xml2blob( _In_ DWORD dwFlags, _In_ IXMLDOMNode *pConfigRoot, @@ -63,10 +67,14 @@ namespace eap /// /// Converts the configuration BLOB to XML. /// - /// The configuration BLOB is returned in the ppConnectionDataOut parameter of the EapPeerInvokeConfigUI function. + /// The configuration BLOB is returned in the `ppConnectionDataOut` parameter of the `EapPeerInvokeConfigUI` function. /// /// \sa [EapPeerConfigBlob2Xml function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363601.aspx) /// + /// \returns + /// - \c true if succeeded + /// - \c false otherwise. See \p ppEapError for details. + /// virtual bool config_blob2xml( _In_ DWORD dwFlags, _In_count_(dwConnectionDataSize) const BYTE *pConnectionData,