Documentation update

This commit is contained in:
Simon Rozman 2016-08-05 15:52:27 +02:00
parent 54bb2050fa
commit 2711425677
7 changed files with 42 additions and 2 deletions

View File

@ -102,6 +102,10 @@ namespace eap
/// ///
/// Test credentials if blank /// Test credentials if blank
/// ///
/// \returns
/// - \c true if blank
/// - \c false otherwise
///
virtual bool empty() const; virtual bool empty() const;
/// \name XML configuration management /// \name XML configuration management
@ -247,6 +251,10 @@ namespace eap
/// ///
/// Test credentials if blank /// Test credentials if blank
/// ///
/// \returns
/// - \c true if blank
/// - \c false otherwise
///
virtual bool empty() const; virtual bool empty() const;
/// \name XML configuration management /// \name XML configuration management

View File

@ -731,6 +731,10 @@ namespace eap
/// ///
/// \sa [EapPeerCredentialsXml2Blob function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363603.aspx) /// \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( virtual bool credentials_xml2blob(
_In_ DWORD dwFlags, _In_ DWORD dwFlags,
_In_ IXMLDOMNode *pConfigRoot, _In_ IXMLDOMNode *pConfigRoot,

View File

@ -50,6 +50,10 @@ namespace eap
/// ///
/// \sa [EapPeerConfigXml2Blob function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363602.aspx) /// \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( virtual bool config_xml2blob(
_In_ DWORD dwFlags, _In_ DWORD dwFlags,
_In_ IXMLDOMNode *pConfigRoot, _In_ IXMLDOMNode *pConfigRoot,
@ -60,10 +64,14 @@ namespace eap
/// ///
/// Converts the configuration BLOB to XML. /// 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) /// \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( virtual bool config_blob2xml(
_In_ DWORD dwFlags, _In_ DWORD dwFlags,
_In_count_(dwConnectionDataSize) const BYTE *pConnectionData, _In_count_(dwConnectionDataSize) const BYTE *pConnectionData,

View File

@ -97,6 +97,10 @@ namespace eap
/// ///
/// Test credentials if blank /// Test credentials if blank
/// ///
/// \returns
/// - \c true if blank
/// - \c false otherwise
///
virtual bool empty() const; virtual bool empty() const;
/// \name XML credentials management /// \name XML credentials management

View File

@ -93,6 +93,10 @@ namespace eap
/// ///
/// Test credentials if blank /// Test credentials if blank
/// ///
/// \returns
/// - \c true if blank
/// - \c false otherwise
///
virtual bool empty() const; virtual bool empty() const;
/// \name XML credentials management /// \name XML credentials management

View File

@ -117,6 +117,10 @@ namespace eap
/// ///
/// \sa [EapPeerCredentialsXml2Blob function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363603.aspx) /// \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( virtual bool credentials_xml2blob(
_In_ DWORD dwFlags, _In_ DWORD dwFlags,
_In_ IXMLDOMNode *pConfigRoot, _In_ IXMLDOMNode *pConfigRoot,

View File

@ -53,6 +53,10 @@ namespace eap
/// ///
/// \sa [EapPeerConfigXml2Blob function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363602.aspx) /// \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( virtual bool config_xml2blob(
_In_ DWORD dwFlags, _In_ DWORD dwFlags,
_In_ IXMLDOMNode *pConfigRoot, _In_ IXMLDOMNode *pConfigRoot,
@ -63,10 +67,14 @@ namespace eap
/// ///
/// Converts the configuration BLOB to XML. /// 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) /// \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( virtual bool config_blob2xml(
_In_ DWORD dwFlags, _In_ DWORD dwFlags,
_In_count_(dwConnectionDataSize) const BYTE *pConnectionData, _In_count_(dwConnectionDataSize) const BYTE *pConnectionData,