From 59e920cf10f2ca7a18389081e142c9c588f028a7 Mon Sep 17 00:00:00 2001 From: Jan Haller Date: Sat, 29 Mar 2014 12:42:13 +0100 Subject: [PATCH] Fixed several Doxygen warnings, limited input to *.hpp files --- doc/doxyfile.in | 25 +------------------------ include/SFML/Audio/SoundRecorder.hpp | 2 +- include/SFML/Graphics/Shader.hpp | 11 ++++++++++- include/SFML/System/Err.hpp | 4 +++- include/SFML/System/Thread.hpp | 2 +- 5 files changed, 16 insertions(+), 28 deletions(-) diff --git a/doc/doxyfile.in b/doc/doxyfile.in index 6f4f26ed..2fd02cdd 100644 --- a/doc/doxyfile.in +++ b/doc/doxyfile.in @@ -591,30 +591,7 @@ INPUT_ENCODING = UTF-8 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.d \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.idl \ - *.odl \ - *.cs \ - *.php \ - *.php3 \ - *.inc \ - *.dox \ - *.py +FILE_PATTERNS = *.hpp # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. diff --git a/include/SFML/Audio/SoundRecorder.hpp b/include/SFML/Audio/SoundRecorder.hpp index 51ccb7f0..2ad250c1 100644 --- a/include/SFML/Audio/SoundRecorder.hpp +++ b/include/SFML/Audio/SoundRecorder.hpp @@ -126,7 +126,7 @@ public : /// while recording). If you do so while recording and /// opening the device fails, it stops the recording. /// - /// \param The name of the audio capture device + /// \param name The name of the audio capture device /// /// \return True, if it was able to set the requested device /// diff --git a/include/SFML/Graphics/Shader.hpp b/include/SFML/Graphics/Shader.hpp index b9494040..99f86dbb 100644 --- a/include/SFML/Graphics/Shader.hpp +++ b/include/SFML/Graphics/Shader.hpp @@ -63,11 +63,20 @@ public : }; //////////////////////////////////////////////////////////// - /// \brief Special type/value that can be passed to setParameter, + /// \brief Special type that can be passed to setParameter, /// and that represents the texture of the object being drawn /// + /// \see setParameter(const std::string&, CurrentTextureType) + /// //////////////////////////////////////////////////////////// struct CurrentTextureType {}; + + //////////////////////////////////////////////////////////// + /// \brief Represents the texture of the object being drawn + /// + /// \see setParameter(const std::string&, CurrentTextureType) + /// + //////////////////////////////////////////////////////////// static CurrentTextureType CurrentTexture; public : diff --git a/include/SFML/System/Err.hpp b/include/SFML/System/Err.hpp index 4190880a..3e845add 100644 --- a/include/SFML/System/Err.hpp +++ b/include/SFML/System/Err.hpp @@ -58,7 +58,7 @@ SFML_SYSTEM_API std::ostream& err(); /// insertion operations defined by the STL /// (operator <<, manipulators, etc.). /// -/// sf::err() can be redirected to write to another output, independantly +/// sf::err() can be redirected to write to another output, independently /// of std::cerr, by using the rdbuf() function provided by the /// std::ostream class. /// @@ -75,4 +75,6 @@ SFML_SYSTEM_API std::ostream& err(); /// sf::err().rdbuf(previous); /// \endcode /// +/// \return Reference to std::ostream representing the SFML error stream +/// //////////////////////////////////////////////////////////// diff --git a/include/SFML/System/Thread.hpp b/include/SFML/System/Thread.hpp index 8ed80556..c2b4eb2c 100644 --- a/include/SFML/System/Thread.hpp +++ b/include/SFML/System/Thread.hpp @@ -212,7 +212,7 @@ private : /// that you can use several types of entry points: /// \li non-member functions with no argument /// \li non-member functions with one argument of any type -/// \li functors with no argument (this one is particularly useful for compatibility with boost/std::bind) +/// \li functors with no argument (this one is particularly useful for compatibility with boost/std::%bind) /// \li functors with one argument of any type /// \li member functions from any class with no argument ///