Fixed several Doxygen warnings, limited input to *.hpp files

This commit is contained in:
Jan Haller 2014-03-29 12:42:13 +01:00
parent 1319a0a096
commit 59e920cf10
5 changed files with 16 additions and 28 deletions

View File

@ -591,30 +591,7 @@ INPUT_ENCODING = UTF-8
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.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 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
FILE_PATTERNS = *.c \ FILE_PATTERNS = *.hpp
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.d \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.idl \
*.odl \
*.cs \
*.php \
*.php3 \
*.inc \
*.dox \
*.py
# The RECURSIVE tag can be used to turn specify whether or not subdirectories # 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. # should be searched for input files as well. Possible values are YES and NO.

View File

@ -126,7 +126,7 @@ public :
/// while recording). If you do so while recording and /// while recording). If you do so while recording and
/// opening the device fails, it stops the recording. /// 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 /// \return True, if it was able to set the requested device
/// ///

View File

@ -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 /// and that represents the texture of the object being drawn
/// ///
/// \see setParameter(const std::string&, CurrentTextureType)
///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
struct CurrentTextureType {}; struct CurrentTextureType {};
////////////////////////////////////////////////////////////
/// \brief Represents the texture of the object being drawn
///
/// \see setParameter(const std::string&, CurrentTextureType)
///
////////////////////////////////////////////////////////////
static CurrentTextureType CurrentTexture; static CurrentTextureType CurrentTexture;
public : public :

View File

@ -58,7 +58,7 @@ SFML_SYSTEM_API std::ostream& err();
/// insertion operations defined by the STL /// insertion operations defined by the STL
/// (operator <<, manipulators, etc.). /// (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 /// of std::cerr, by using the rdbuf() function provided by the
/// std::ostream class. /// std::ostream class.
/// ///
@ -75,4 +75,6 @@ SFML_SYSTEM_API std::ostream& err();
/// sf::err().rdbuf(previous); /// sf::err().rdbuf(previous);
/// \endcode /// \endcode
/// ///
/// \return Reference to std::ostream representing the SFML error stream
///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////

View File

@ -212,7 +212,7 @@ private :
/// that you can use several types of entry points: /// that you can use several types of entry points:
/// \li non-member functions with no argument /// \li non-member functions with no argument
/// \li non-member functions with one argument of any type /// \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 functors with one argument of any type
/// \li member functions from any class with no argument /// \li member functions from any class with no argument
/// ///