mirrors/SFML
1
0
Fork 0
mirror of https://github.com/SFML/SFML.git synced 2024-11-28 22:31:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fixed documentation for MemoryInputStream and FileInputStream

Browse Source
This commit is contained in:
Marco Antognini 2015-09-13 11:57:04 +02:00
parent 58643d78f9
commit 1b2c50a0d8
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/SFML/System/FileInputStream.hpp
View File

@ -136,7 +136,7 @@ private:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class FileInputStream /// \class sf::FileInputStream
/// \ingroup system /// \ingroup system
/// ///
/// This class is a specialization of InputStream that /// This class is a specialization of InputStream that
@ -153,17 +153,17 @@ private:
/// ///
/// SFML resource classes can usually be loaded directly from /// SFML resource classes can usually be loaded directly from
/// a filename, so this class shouldn't be useful to you unless /// a filename, so this class shouldn't be useful to you unless
/// you create your own algorithms that operate on a InputStream. /// you create your own algorithms that operate on an InputStream.
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// void process(InputStream& stream); /// void process(InputStream& stream);
/// ///
/// FileStream stream; /// FileInputStream stream;
/// if (stream.open("some_file.dat")) /// if (stream.open("some_file.dat"))
/// process(stream); /// process(stream);
/// \endcode /// \endcode
/// ///
/// InputStream, MemoryStream /// InputStream, MemoryInputStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////

8
include/SFML/System/MemoryInputStream.hpp
View File

@ -116,7 +116,7 @@ private:
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class MemoryeInputStream /// \class sf::MemoryInputStream
/// \ingroup system /// \ingroup system
/// ///
/// This class is a specialization of InputStream that /// This class is a specialization of InputStream that
@ -132,17 +132,17 @@ private:
/// ///
/// SFML resource classes can usually be loaded directly from /// SFML resource classes can usually be loaded directly from
/// memory, so this class shouldn't be useful to you unless /// memory, so this class shouldn't be useful to you unless
/// you create your own algorithms that operate on a InputStream. /// you create your own algorithms that operate on an InputStream.
/// ///
/// Usage example: /// Usage example:
/// \code /// \code
/// void process(InputStream& stream); /// void process(InputStream& stream);
/// ///
/// MemoryStream stream; /// MemoryInputStream stream;
/// stream.open(thePtr, theSize); /// stream.open(thePtr, theSize);
/// process(stream); /// process(stream);
/// \endcode /// \endcode
/// ///
/// InputStream, FileStream /// InputStream, FileInputStream
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////