diff options
author | Jeffrey Walton <noloader@gmail.com> | 2020-12-07 23:35:10 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2020-12-07 23:35:10 -0500 |
commit | ac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb (patch) | |
tree | a0f63ebf397db67a1d8f7e41f2e4e89d03a57a4f /files.h | |
parent | 4d2b58c8fe92e7ce5007d2f15f046d33f37eedc2 (diff) | |
download | cryptopp-git-ac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb.tar.gz |
Use \return and \throw consitently in the docs
Diffstat (limited to 'files.h')
-rw-r--r-- | files.h | 8 |
1 files changed, 4 insertions, 4 deletions
@@ -55,11 +55,11 @@ public: #endif
/// \brief Retrieves the internal stream
- /// \returns the internal stream pointer
+ /// \return the internal stream pointer
std::istream* GetStream() {return m_stream;}
/// \brief Retrieves the internal stream
- /// \returns the internal stream pointer
+ /// \return the internal stream pointer
const std::istream* GetStream() const {return m_stream;}
/// \brief Provides the number of bytes ready for retrieval
@@ -121,7 +121,7 @@ public: #endif
/// \brief Retrieves the internal stream
- /// \returns the internal stream pointer
+ /// \return the internal stream pointer
std::istream* GetStream() {return m_store.GetStream();}
};
@@ -164,7 +164,7 @@ public: #endif
/// \brief Retrieves the internal stream
- /// \returns the internal stream pointer
+ /// \return the internal stream pointer
std::ostream* GetStream() {return m_stream;}
void IsolatedInitialize(const NameValuePairs ¶meters);
|