From ac6987f3aee8fedd52a08f8d6e9b7d5ad28559bb Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Mon, 7 Dec 2020 23:35:10 -0500 Subject: Use \return and \throw consitently in the docs --- files.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'files.h') diff --git a/files.h b/files.h index 16fe46f2..8ff5dc85 100644 --- a/files.h +++ b/files.h @@ -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); -- cgit v1.2.1