Changed Doxygen single-line comment format

Single line comments starting with `///` are interpreted by
Microsoft Visual Studio as documentation containing XML code.

Therefore single line comments starting with `///<` unfortunately
cause a parsing error, as IntelliSense will assume the `<` is the
start of an XML tag. This is not the case, but unfortunately,
IntelliSense will still complain about the following space
character rather than displaying the raw string. This commit alters
all such comments to start with `//!<` instead, which prevents the
issue.

This fixes issue #1622.

include/SFML/Audio/InputSoundFile.hpp

@@ -206,13 +206,13 @@ class SFML_AUDIO_API InputSoundFile : NonCopyable
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    SoundFileReader* m_reader;       ///< Reader that handles I/O on the file's format
-    InputStream*     m_stream;       ///< Input stream used to access the file's data
-    bool             m_streamOwned;  ///< Is the stream internal or external?
-    Uint64           m_sampleOffset; ///< Sample Read Position
-    Uint64           m_sampleCount;  ///< Total number of samples in the file
-    unsigned int     m_channelCount; ///< Number of channels of the sound
-    unsigned int     m_sampleRate;   ///< Number of samples per second
+    SoundFileReader* m_reader;       //!< Reader that handles I/O on the file's format
+    InputStream*     m_stream;       //!< Input stream used to access the file's data
+    bool             m_streamOwned;  //!< Is the stream internal or external?
+    Uint64           m_sampleOffset; //!< Sample Read Position
+    Uint64           m_sampleCount;  //!< Total number of samples in the file
+    unsigned int     m_channelCount; //!< Number of channels of the sound
+    unsigned int     m_sampleRate;   //!< Number of samples per second
 };
 
 } // namespace sf

include/SFML/Audio/Music.hpp

@@ -79,8 +79,8 @@ class SFML_AUDIO_API Music : public SoundStream
 
         }
 
-        T offset; ///< The beginning offset of the time range
-        T length; ///< The length of the time range
+        T offset; //!< The beginning offset of the time range
+        T length; //!< The length of the time range
     };
 
     // Define the relevant Span types
@@ -276,10 +276,10 @@ class SFML_AUDIO_API Music : public SoundStream
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    InputSoundFile     m_file;     ///< The streamed music file
-    std::vector<Int16> m_samples;  ///< Temporary buffer of samples
-    Mutex              m_mutex;    ///< Mutex protecting the data
-    Span<Uint64>       m_loopSpan; ///< Loop Range Specifier
+    InputSoundFile     m_file;     //!< The streamed music file
+    std::vector<Int16> m_samples;  //!< Temporary buffer of samples
+    Mutex              m_mutex;    //!< Mutex protecting the data
+    Span<Uint64>       m_loopSpan; //!< Loop Range Specifier
 };
 
 } // namespace sf

include/SFML/Audio/OutputSoundFile.hpp

@@ -93,7 +93,7 @@ class SFML_AUDIO_API OutputSoundFile : NonCopyable
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    SoundFileWriter* m_writer; ///< Writer that handles I/O on the file's format
+    SoundFileWriter* m_writer; //!< Writer that handles I/O on the file's format
 };
 
 } // namespace sf

include/SFML/Audio/Sound.hpp

@@ -217,7 +217,7 @@ class SFML_AUDIO_API Sound : public SoundSource
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    const SoundBuffer* m_buffer; ///< Sound buffer bound to the source
+    const SoundBuffer* m_buffer; //!< Sound buffer bound to the source
 };
 
 } // namespace sf

include/SFML/Audio/SoundBuffer.hpp

@@ -267,15 +267,15 @@ class SFML_AUDIO_API SoundBuffer : AlResource
     ////////////////////////////////////////////////////////////
     // Types
     ////////////////////////////////////////////////////////////
-    typedef std::set<Sound*> SoundList; ///< Set of unique sound instances
+    typedef std::set<Sound*> SoundList; //!< Set of unique sound instances
 
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    unsigned int       m_buffer;   ///< OpenAL buffer identifier
-    std::vector<Int16> m_samples;  ///< Samples buffer
-    Time               m_duration; ///< Sound duration
-    mutable SoundList  m_sounds;   ///< List of sounds that are using this buffer
+    unsigned int       m_buffer;   //!< OpenAL buffer identifier
+    std::vector<Int16> m_samples;  //!< Samples buffer
+    Time               m_duration; //!< Sound duration
+    mutable SoundList  m_sounds;   //!< List of sounds that are using this buffer
 };
 
 } // namespace sf

include/SFML/Audio/SoundBufferRecorder.hpp

@@ -96,8 +96,8 @@ class SFML_AUDIO_API SoundBufferRecorder : public SoundRecorder
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    std::vector<Int16> m_samples; ///< Temporary sample buffer to hold the recorded data
-    SoundBuffer        m_buffer;  ///< Sound buffer that will contain the recorded data
+    std::vector<Int16> m_samples; //!< Temporary sample buffer to hold the recorded data
+    SoundBuffer        m_buffer;  //!< Sound buffer that will contain the recorded data
 };
 
 } // namespace sf

include/SFML/Audio/SoundFileFactory.hpp

@@ -160,8 +160,8 @@ class SFML_AUDIO_API SoundFileFactory
     ////////////////////////////////////////////////////////////
     // Static member data
     ////////////////////////////////////////////////////////////
-    static ReaderFactoryArray s_readers; ///< List of all registered readers
-    static WriterFactoryArray s_writers; ///< List of all registered writers
+    static ReaderFactoryArray s_readers; //!< List of all registered readers
+    static WriterFactoryArray s_writers; //!< List of all registered writers
 };
 
 } // namespace sf

include/SFML/Audio/SoundFileReader.hpp

@@ -50,9 +50,9 @@ class SFML_AUDIO_API SoundFileReader
     ////////////////////////////////////////////////////////////
     struct Info
     {
-        Uint64       sampleCount;  ///< Total number of samples in the file
-        unsigned int channelCount; ///< Number of channels of the sound
-        unsigned int sampleRate;   ///< Samples rate of the sound, in samples per second
+        Uint64       sampleCount;  //!< Total number of samples in the file
+        unsigned int channelCount; //!< Number of channels of the sound
+        unsigned int sampleRate;   //!< Samples rate of the sound, in samples per second
     };
 
     ////////////////////////////////////////////////////////////

include/SFML/Audio/SoundRecorder.hpp

@@ -285,13 +285,13 @@ class SFML_AUDIO_API SoundRecorder : AlResource
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    Thread             m_thread;             ///< Thread running the background recording task
-    std::vector<Int16> m_samples;            ///< Buffer to store captured samples
-    unsigned int       m_sampleRate;         ///< Sample rate
-    Time               m_processingInterval; ///< Time period between calls to onProcessSamples
-    bool               m_isCapturing;        ///< Capturing state
-    std::string        m_deviceName;         ///< Name of the audio capture device
-    unsigned int       m_channelCount;       ///< Number of recording channels
+    Thread             m_thread;             //!< Thread running the background recording task
+    std::vector<Int16> m_samples;            //!< Buffer to store captured samples
+    unsigned int       m_sampleRate;         //!< Sample rate
+    Time               m_processingInterval; //!< Time period between calls to onProcessSamples
+    bool               m_isCapturing;        //!< Capturing state
+    std::string        m_deviceName;         //!< Name of the audio capture device
+    unsigned int       m_channelCount;       //!< Number of recording channels
 };
 
 } // namespace sf

include/SFML/Audio/SoundSource.hpp

@@ -49,9 +49,9 @@ class SFML_AUDIO_API SoundSource : AlResource
     ////////////////////////////////////////////////////////////
     enum Status
     {
-        Stopped, ///< Sound is not playing
-        Paused,  ///< Sound is paused
-        Playing  ///< Sound is playing
+        Stopped, //!< Sound is not playing
+        Paused,  //!< Sound is paused
+        Playing  //!< Sound is playing
     };
 
     ////////////////////////////////////////////////////////////
@@ -306,7 +306,7 @@ class SFML_AUDIO_API SoundSource : AlResource
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    unsigned int m_source; ///< OpenAL source identifier
+    unsigned int m_source; //!< OpenAL source identifier
 };
 
 } // namespace sf

include/SFML/Audio/SoundStream.hpp

@@ -52,8 +52,8 @@ class SFML_AUDIO_API SoundStream : public SoundSource
     ////////////////////////////////////////////////////////////
     struct Chunk
     {
-        const Int16* samples;     ///< Pointer to the audio samples
-        std::size_t  sampleCount; ///< Number of samples pointed by Samples
+        const Int16* samples;     //!< Pointer to the audio samples
+        std::size_t  sampleCount; //!< Number of samples pointed by Samples
     };
 
     ////////////////////////////////////////////////////////////
@@ -182,7 +182,7 @@ class SFML_AUDIO_API SoundStream : public SoundSource
 
     enum
     {
-        NoLoop = -1 ///< "Invalid" endSeeks value, telling us to continue uninterrupted
+        NoLoop = -1 //!< "Invalid" endSeeks value, telling us to continue uninterrupted
     };
 
     ////////////////////////////////////////////////////////////
@@ -299,24 +299,24 @@ class SFML_AUDIO_API SoundStream : public SoundSource
 
     enum
     {
-        BufferCount = 3,    ///< Number of audio buffers used by the streaming loop
-        BufferRetries = 2   ///< Number of retries (excluding initial try) for onGetData()
+        BufferCount = 3,    //!< Number of audio buffers used by the streaming loop
+        BufferRetries = 2   //!< Number of retries (excluding initial try) for onGetData()
     };
 
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    Thread        m_thread;                   ///< Thread running the background tasks
-    mutable Mutex m_threadMutex;              ///< Thread mutex
-    Status        m_threadStartState;         ///< State the thread starts in (Playing, Paused, Stopped)
-    bool          m_isStreaming;              ///< Streaming state (true = playing, false = stopped)
-    unsigned int  m_buffers[BufferCount];     ///< Sound buffers used to store temporary audio data
-    unsigned int  m_channelCount;             ///< Number of channels (1 = mono, 2 = stereo, ...)
-    unsigned int  m_sampleRate;               ///< Frequency (samples / second)
-    Uint32        m_format;                   ///< Format of the internal sound buffers
-    bool          m_loop;                     ///< Loop flag (true to loop, false to play once)
-    Uint64        m_samplesProcessed;         ///< Number of buffers processed since beginning of the stream
-    Int64         m_bufferSeeks[BufferCount]; ///< If buffer is an "end buffer", holds next seek position, else NoLoop. For play offset calculation.
+    Thread        m_thread;                   //!< Thread running the background tasks
+    mutable Mutex m_threadMutex;              //!< Thread mutex
+    Status        m_threadStartState;         //!< State the thread starts in (Playing, Paused, Stopped)
+    bool          m_isStreaming;              //!< Streaming state (true = playing, false = stopped)
+    unsigned int  m_buffers[BufferCount];     //!< Sound buffers used to store temporary audio data
+    unsigned int  m_channelCount;             //!< Number of channels (1 = mono, 2 = stereo, ...)
+    unsigned int  m_sampleRate;               //!< Frequency (samples / second)
+    Uint32        m_format;                   //!< Format of the internal sound buffers
+    bool          m_loop;                     //!< Loop flag (true to loop, false to play once)
+    Uint64        m_samplesProcessed;         //!< Number of buffers processed since beginning of the stream
+    Int64         m_bufferSeeks[BufferCount]; //!< If buffer is an "end buffer", holds next seek position, else NoLoop. For play offset calculation.
 };
 
 } // namespace sf

include/SFML/Graphics/BlendMode.hpp

@@ -48,16 +48,16 @@ struct SFML_GRAPHICS_API BlendMode
     ////////////////////////////////////////////////////////
     enum Factor
     {
-        Zero,             ///< (0, 0, 0, 0)
-        One,              ///< (1, 1, 1, 1)
-        SrcColor,         ///< (src.r, src.g, src.b, src.a)
-        OneMinusSrcColor, ///< (1, 1, 1, 1) - (src.r, src.g, src.b, src.a)
-        DstColor,         ///< (dst.r, dst.g, dst.b, dst.a)
-        OneMinusDstColor, ///< (1, 1, 1, 1) - (dst.r, dst.g, dst.b, dst.a)
-        SrcAlpha,         ///< (src.a, src.a, src.a, src.a)
-        OneMinusSrcAlpha, ///< (1, 1, 1, 1) - (src.a, src.a, src.a, src.a)
-        DstAlpha,         ///< (dst.a, dst.a, dst.a, dst.a)
-        OneMinusDstAlpha  ///< (1, 1, 1, 1) - (dst.a, dst.a, dst.a, dst.a)
+        Zero,             //!< (0, 0, 0, 0)
+        One,              //!< (1, 1, 1, 1)
+        SrcColor,         //!< (src.r, src.g, src.b, src.a)
+        OneMinusSrcColor, //!< (1, 1, 1, 1) - (src.r, src.g, src.b, src.a)
+        DstColor,         //!< (dst.r, dst.g, dst.b, dst.a)
+        OneMinusDstColor, //!< (1, 1, 1, 1) - (dst.r, dst.g, dst.b, dst.a)
+        SrcAlpha,         //!< (src.a, src.a, src.a, src.a)
+        OneMinusSrcAlpha, //!< (1, 1, 1, 1) - (src.a, src.a, src.a, src.a)
+        DstAlpha,         //!< (dst.a, dst.a, dst.a, dst.a)
+        OneMinusDstAlpha  //!< (1, 1, 1, 1) - (dst.a, dst.a, dst.a, dst.a)
     };
 
     ////////////////////////////////////////////////////////
@@ -68,9 +68,9 @@ struct SFML_GRAPHICS_API BlendMode
     ////////////////////////////////////////////////////////
     enum Equation
     {
-        Add,            ///< Pixel = Src * SrcFactor + Dst * DstFactor
-        Subtract,       ///< Pixel = Src * SrcFactor - Dst * DstFactor
-        ReverseSubtract ///< Pixel = Dst * DstFactor - Src * SrcFactor
+        Add,            //!< Pixel = Src * SrcFactor + Dst * DstFactor
+        Subtract,       //!< Pixel = Src * SrcFactor - Dst * DstFactor
+        ReverseSubtract //!< Pixel = Dst * DstFactor - Src * SrcFactor
     };
 
     ////////////////////////////////////////////////////////////
@@ -112,12 +112,12 @@ struct SFML_GRAPHICS_API BlendMode
     ////////////////////////////////////////////////////////////
     // Member Data
     ////////////////////////////////////////////////////////////
-    Factor   colorSrcFactor; ///< Source blending factor for the color channels
-    Factor   colorDstFactor; ///< Destination blending factor for the color channels
-    Equation colorEquation;  ///< Blending equation for the color channels
-    Factor   alphaSrcFactor; ///< Source blending factor for the alpha channel
-    Factor   alphaDstFactor; ///< Destination blending factor for the alpha channel
-    Equation alphaEquation;  ///< Blending equation for the alpha channel
+    Factor   colorSrcFactor; //!< Source blending factor for the color channels
+    Factor   colorDstFactor; //!< Destination blending factor for the color channels
+    Equation colorEquation;  //!< Blending equation for the color channels
+    Factor   alphaSrcFactor; //!< Source blending factor for the alpha channel
+    Factor   alphaDstFactor; //!< Destination blending factor for the alpha channel
+    Equation alphaEquation;  //!< Blending equation for the alpha channel
 };
 
 ////////////////////////////////////////////////////////////
@@ -147,10 +147,10 @@ SFML_GRAPHICS_API bool operator !=(const BlendMode& left, const BlendMode& right
 ////////////////////////////////////////////////////////////
 // Commonly used blending modes
 ////////////////////////////////////////////////////////////
-SFML_GRAPHICS_API extern const BlendMode BlendAlpha;    ///< Blend source and dest according to dest alpha
-SFML_GRAPHICS_API extern const BlendMode BlendAdd;      ///< Add source to dest
-SFML_GRAPHICS_API extern const BlendMode BlendMultiply; ///< Multiply source and dest
-SFML_GRAPHICS_API extern const BlendMode BlendNone;     ///< Overwrite dest with source
+SFML_GRAPHICS_API extern const BlendMode BlendAlpha;    //!< Blend source and dest according to dest alpha
+SFML_GRAPHICS_API extern const BlendMode BlendAdd;      //!< Add source to dest
+SFML_GRAPHICS_API extern const BlendMode BlendMultiply; //!< Multiply source and dest
+SFML_GRAPHICS_API extern const BlendMode BlendNone;     //!< Overwrite dest with source
 
 } // namespace sf
 

include/SFML/Graphics/CircleShape.hpp

@@ -111,8 +111,8 @@ class SFML_GRAPHICS_API CircleShape : public Shape
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    float       m_radius;     ///< Radius of the circle
-    std::size_t m_pointCount; ///< Number of points composing the circle
+    float       m_radius;     //!< Radius of the circle
+    std::size_t m_pointCount; //!< Number of points composing the circle
 };
 
 } // namespace sf

include/SFML/Graphics/Color.hpp

@@ -80,23 +80,23 @@ class SFML_GRAPHICS_API Color
     ////////////////////////////////////////////////////////////
     // Static member data
     ////////////////////////////////////////////////////////////
-    static const Color Black;       ///< Black predefined color
-    static const Color White;       ///< White predefined color
-    static const Color Red;         ///< Red predefined color
-    static const Color Green;       ///< Green predefined color
-    static const Color Blue;        ///< Blue predefined color
-    static const Color Yellow;      ///< Yellow predefined color
-    static const Color Magenta;     ///< Magenta predefined color
-    static const Color Cyan;        ///< Cyan predefined color
-    static const Color Transparent; ///< Transparent (black) predefined color
+    static const Color Black;       //!< Black predefined color
+    static const Color White;       //!< White predefined color
+    static const Color Red;         //!< Red predefined color
+    static const Color Green;       //!< Green predefined color
+    static const Color Blue;        //!< Blue predefined color
+    static const Color Yellow;      //!< Yellow predefined color
+    static const Color Magenta;     //!< Magenta predefined color
+    static const Color Cyan;        //!< Cyan predefined color
+    static const Color Transparent; //!< Transparent (black) predefined color
 
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    Uint8 r; ///< Red component
-    Uint8 g; ///< Green component
-    Uint8 b; ///< Blue component
-    Uint8 a; ///< Alpha (opacity) component
+    Uint8 r; //!< Red component
+    Uint8 g; //!< Green component
+    Uint8 b; //!< Blue component
+    Uint8 a; //!< Alpha (opacity) component
 };
 
 ////////////////////////////////////////////////////////////

include/SFML/Graphics/ConvexShape.hpp

@@ -112,7 +112,7 @@ class SFML_GRAPHICS_API ConvexShape : public Shape
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    std::vector<Vector2f> m_points; ///< Points composing the convex polygon
+    std::vector<Vector2f> m_points; //!< Points composing the convex polygon
 };
 
 } // namespace sf