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.

src/SFML/Audio/SoundFileReaderFlac.hpp

@@ -132,8 +132,8 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    FLAC__StreamDecoder* m_decoder;    ///< FLAC decoder
-    ClientData           m_clientData; ///< Structure passed to the decoder callbacks
+    FLAC__StreamDecoder* m_decoder;    //!< FLAC decoder
+    ClientData           m_clientData; //!< Structure passed to the decoder callbacks
 };
 
 } // namespace priv

src/SFML/Audio/SoundFileReaderWav.hpp

@@ -112,10 +112,10 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    InputStream* m_stream;         ///< Source stream to read from
-    unsigned int m_bytesPerSample; ///< Size of a sample, in bytes
-    Uint64       m_dataStart;      ///< Starting position of the audio data in the open file
-    Uint64       m_dataEnd;        ///< Position one byte past the end of the audio data in the open file
+    InputStream* m_stream;         //!< Source stream to read from
+    unsigned int m_bytesPerSample; //!< Size of a sample, in bytes
+    Uint64       m_dataStart;      //!< Starting position of the audio data in the open file
+    Uint64       m_dataEnd;        //!< Position one byte past the end of the audio data in the open file
 };
 
 } // namespace priv

src/SFML/Audio/SoundFileWriterFlac.hpp

@@ -101,9 +101,9 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    FLAC__StreamEncoder* m_encoder;      ///< FLAC stream encoder
-    unsigned int         m_channelCount; ///< Number of channels
-    std::vector<Int32>   m_samples32;    ///< Conversion buffer
+    FLAC__StreamEncoder* m_encoder;      //!< FLAC stream encoder
+    unsigned int         m_channelCount; //!< Number of channels
+    std::vector<Int32>   m_samples32;    //!< Conversion buffer
 };
 
 } // namespace priv

src/SFML/Audio/SoundFileWriterWav.hpp

@@ -112,7 +112,7 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    std::ofstream m_file;         ///< File stream to write to
+    std::ofstream m_file;         //!< File stream to write to
 };
 
 } // namespace priv

src/SFML/Graphics/RenderTextureImplDefault.hpp

@@ -102,9 +102,9 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    Context*     m_context; ///< P-Buffer based context
-    unsigned int m_width;   ///< Width of the P-Buffer
-    unsigned int m_height;  ///< Height of the P-Buffer
+    Context*     m_context; //!< P-Buffer based context
+    unsigned int m_width;   //!< Width of the P-Buffer
+    unsigned int m_height;  //!< Height of the P-Buffer
 };
 
 } // namespace priv

src/SFML/Graphics/RenderTextureImplFBO.hpp

@@ -125,16 +125,16 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    std::map<Uint64, unsigned int> m_frameBuffers;            ///< OpenGL frame buffer objects per context
-    std::map<Uint64, unsigned int> m_multisampleFrameBuffers; ///< Optional per-context OpenGL frame buffer objects with multisample attachments
-    unsigned int                   m_depthStencilBuffer;      ///< Optional depth/stencil buffer attached to the frame buffer
-    unsigned int                   m_colorBuffer;             ///< Optional multisample color buffer attached to the frame buffer
-    unsigned int                   m_width;                   ///< Width of the attachments
-    unsigned int                   m_height;                  ///< Height of the attachments
-    Context*                       m_context;                 ///< Backup OpenGL context, used when none already exist
-    unsigned int                   m_textureId;               ///< The ID of the texture to attach to the FBO
-    bool                           m_multisample;             ///< Whether we have to create a multisample frame buffer as well
-    bool                           m_stencil;                 ///< Whether we have stencil attachment
+    std::map<Uint64, unsigned int> m_frameBuffers;            //!< OpenGL frame buffer objects per context
+    std::map<Uint64, unsigned int> m_multisampleFrameBuffers; //!< Optional per-context OpenGL frame buffer objects with multisample attachments
+    unsigned int                   m_depthStencilBuffer;      //!< Optional depth/stencil buffer attached to the frame buffer
+    unsigned int                   m_colorBuffer;             //!< Optional multisample color buffer attached to the frame buffer
+    unsigned int                   m_width;                   //!< Width of the attachments
+    unsigned int                   m_height;                  //!< Height of the attachments
+    Context*                       m_context;                 //!< Backup OpenGL context, used when none already exist
+    unsigned int                   m_textureId;               //!< The ID of the texture to attach to the FBO
+    bool                           m_multisample;             //!< Whether we have to create a multisample frame buffer as well
+    bool                           m_stencil;                 //!< Whether we have stencil attachment
 };
 
 } // namespace priv

src/SFML/Graphics/Shader.cpp

@@ -211,10 +211,10 @@ struct Shader::UniformBinder : private NonCopyable
             glCheck(GLEXT_glUseProgramObject(savedProgram));
     }
 
-    TransientContextLock lock;           ///< Lock to keep context active while uniform is bound
-    GLEXT_GLhandle       savedProgram;   ///< Handle to the previously active program object
-    GLEXT_GLhandle       currentProgram; ///< Handle to the program object of the modified sf::Shader instance
-    GLint                location;       ///< Uniform location, used by the surrounding sf::Shader code
+    TransientContextLock lock;           //!< Lock to keep context active while uniform is bound
+    GLEXT_GLhandle       savedProgram;   //!< Handle to the previously active program object
+    GLEXT_GLhandle       currentProgram; //!< Handle to the program object of the modified sf::Shader instance
+    GLint                location;       //!< Uniform location, used by the surrounding sf::Shader code
 };
 
 

src/SFML/Graphics/TextureSaver.hpp

@@ -64,7 +64,7 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    GLint m_textureBinding; ///< Texture binding to restore
+    GLint m_textureBinding; //!< Texture binding to restore
 };
 
 } // namespace priv

src/SFML/Network/Ftp.cpp

@@ -60,8 +60,8 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    Ftp&      m_ftp;        ///< Reference to the owner Ftp instance
-    TcpSocket m_dataSocket; ///< Socket used for data transfers
+    Ftp&      m_ftp;        //!< Reference to the owner Ftp instance
+    TcpSocket m_dataSocket; //!< Socket used for data transfers
 };
 
 

src/SFML/Network/SocketSelector.cpp

@@ -42,10 +42,10 @@ namespace sf
 ////////////////////////////////////////////////////////////
 struct SocketSelector::SocketSelectorImpl
 {
-    fd_set allSockets;   ///< Set containing all the sockets handles
-    fd_set socketsReady; ///< Set containing handles of the sockets that are ready
-    int    maxSocket;    ///< Maximum socket handle
-    int    socketCount;  ///< Number of socket handles
+    fd_set allSockets;   //!< Set containing all the sockets handles
+    fd_set socketsReady; //!< Set containing handles of the sockets that are ready
+    int    maxSocket;    //!< Maximum socket handle
+    int    socketCount;  //!< Number of socket handles
 };
 
 

src/SFML/System/Win32/MutexImpl.hpp

@@ -72,7 +72,7 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    CRITICAL_SECTION m_mutex; ///< Win32 handle of the mutex
+    CRITICAL_SECTION m_mutex; //!< Win32 handle of the mutex
 };
 
 } // namespace priv

src/SFML/System/Win32/ThreadImpl.hpp

@@ -97,8 +97,8 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    HANDLE m_thread; ///< Win32 thread handle
-    unsigned int m_threadId; ///< Win32 thread identifier
+    HANDLE m_thread; //!< Win32 thread handle
+    unsigned int m_threadId; //!< Win32 thread identifier
 };
 
 } // namespace priv

src/SFML/System/Win32/ThreadLocalImpl.hpp

@@ -76,7 +76,7 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    DWORD m_index; ///< Index of our thread-local storage slot
+    DWORD m_index; //!< Index of our thread-local storage slot
 };
 
 } // namespace priv

src/SFML/Window/EglContext.hpp

@@ -188,10 +188,10 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    EGLDisplay  m_display; ///< The internal EGL display
-    EGLContext  m_context; ///< The internal EGL context
-    EGLSurface  m_surface; ///< The internal EGL surface
-    EGLConfig   m_config;  ///< The internal EGL config
+    EGLDisplay  m_display; //!< The internal EGL display
+    EGLContext  m_context; //!< The internal EGL context
+    EGLSurface  m_surface; //!< The internal EGL surface
+    EGLConfig   m_config;  //!< The internal EGL config
 
 };
 

src/SFML/Window/GlContext.hpp

@@ -273,7 +273,7 @@ protected:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    ContextSettings m_settings; ///< Creation settings of the context
+    ContextSettings m_settings; //!< Creation settings of the context
 
 private:
 
@@ -294,7 +294,7 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    const Uint64 m_id; ///< Unique number that identifies the context
+    const Uint64 m_id; //!< Unique number that identifies the context
 };
 
 } // namespace priv

src/SFML/Window/JoystickImpl.hpp

@@ -50,8 +50,8 @@ struct JoystickCaps
         std::fill(axes, axes + Joystick::AxisCount, false);
     }
 
-    unsigned int buttonCount;               ///< Number of buttons supported by the joystick
-    bool         axes[Joystick::AxisCount]; ///< Support for each axis
+    unsigned int buttonCount;               //!< Number of buttons supported by the joystick
+    bool         axes[Joystick::AxisCount]; //!< Support for each axis
 };
 
 
@@ -68,9 +68,9 @@ struct JoystickState
         std::fill(buttons, buttons + Joystick::ButtonCount, false);
     }
 
-    bool  connected;                      ///< Is the joystick currently connected?
-    float axes[Joystick::AxisCount];      ///< Position of each axis, in range [-100, 100]
-    bool  buttons[Joystick::ButtonCount]; ///< Status of each button (true = pressed)
+    bool  connected;                      //!< Is the joystick currently connected?
+    float axes[Joystick::AxisCount];      //!< Position of each axis, in range [-100, 100]
+    bool  buttons[Joystick::ButtonCount]; //!< Status of each button (true = pressed)
 };
 
 } // namespace priv

src/SFML/Window/JoystickManager.hpp

@@ -109,16 +109,16 @@ private:
     ////////////////////////////////////////////////////////////
     struct Item
     {
-        JoystickImpl             joystick;       ///< Joystick implementation
-        JoystickState            state;          ///< The current joystick state
-        JoystickCaps             capabilities;   ///< The joystick capabilities
-        Joystick::Identification identification; ///< The joystick identification
+        JoystickImpl             joystick;       //!< Joystick implementation
+        JoystickState            state;          //!< The current joystick state
+        JoystickCaps             capabilities;   //!< The joystick capabilities
+        Joystick::Identification identification; //!< The joystick identification
     };
 
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    Item m_joysticks[Joystick::Count]; ///< Joysticks information and state
+    Item m_joysticks[Joystick::Count]; //!< Joysticks information and state
 };
 
 } // namespace priv

src/SFML/Window/SensorManager.hpp

@@ -118,16 +118,16 @@ private:
     ////////////////////////////////////////////////////////////
     struct Item
     {
-        bool available;    ///< Is the sensor available on this device?
-        bool enabled;      ///< Current enable state of the sensor
-        SensorImpl sensor; ///< Sensor implementation
-        Vector3f value;    ///< The current sensor value
+        bool available;    //!< Is the sensor available on this device?
+        bool enabled;      //!< Current enable state of the sensor
+        SensorImpl sensor; //!< Sensor implementation
+        Vector3f value;    //!< The current sensor value
     };
 
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    Item m_sensors[Sensor::Count]; ///< Sensors information and state
+    Item m_sensors[Sensor::Count]; //!< Sensors information and state
 };
 
 } // namespace priv

src/SFML/Window/Win32/JoystickImpl.hpp

@@ -220,13 +220,13 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    unsigned int             m_index;                          ///< Index of the joystick
-    JOYCAPS                  m_caps;                           ///< Joystick capabilities
-    IDirectInputDevice8W*    m_device;                         ///< DirectInput 8.x device
-    DIDEVCAPS                m_deviceCaps;                     ///< DirectInput device capabilities
-    int                      m_axes[Joystick::AxisCount];      ///< Offsets to the bytes containing the axes states, -1 if not available
-    int                      m_buttons[Joystick::ButtonCount]; ///< Offsets to the bytes containing the button states, -1 if not available
-    Joystick::Identification m_identification;                 ///< Joystick identification
+    unsigned int             m_index;                          //!< Index of the joystick
+    JOYCAPS                  m_caps;                           //!< Joystick capabilities
+    IDirectInputDevice8W*    m_device;                         //!< DirectInput 8.x device
+    DIDEVCAPS                m_deviceCaps;                     //!< DirectInput device capabilities
+    int                      m_axes[Joystick::AxisCount];      //!< Offsets to the bytes containing the axes states, -1 if not available
+    int                      m_buttons[Joystick::ButtonCount]; //!< Offsets to the bytes containing the button states, -1 if not available
+    Joystick::Identification m_identification;                 //!< Joystick identification
 };
 
 } // namespace priv

src/SFML/Window/Win32/WglContext.hpp

@@ -179,11 +179,11 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    HWND        m_window;        ///< Window to which the context is attached
-    HPBUFFERARB m_pbuffer;       ///< Handle to a pbuffer if one was created
-    HDC         m_deviceContext; ///< Device context associated to the context
-    HGLRC       m_context;       ///< OpenGL context
-    bool        m_ownsWindow;    ///< Do we own the target window?
+    HWND        m_window;        //!< Window to which the context is attached
+    HPBUFFERARB m_pbuffer;       //!< Handle to a pbuffer if one was created
+    HDC         m_deviceContext; //!< Device context associated to the context
+    HGLRC       m_context;       //!< OpenGL context
+    bool        m_ownsWindow;    //!< Do we own the target window?
 };
 
 } // namespace priv

src/SFML/Window/Win32/WindowImplWin32.hpp

@@ -272,18 +272,18 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    HWND     m_handle;           ///< Win32 handle of the window
-    LONG_PTR m_callback;         ///< Stores the original event callback function of the control
-    bool     m_cursorVisible;    ///< Is the cursor visible or hidden?
-    HCURSOR  m_lastCursor;       ///< Last cursor used -- this data is not owned by the window and is required to be always valid
-    HICON    m_icon;             ///< Custom icon assigned to the window
-    bool     m_keyRepeatEnabled; ///< Automatic key-repeat state for keydown events
-    Vector2u m_lastSize;         ///< The last handled size of the window
-    bool     m_resizing;         ///< Is the window being resized?
-    Uint16   m_surrogate;        ///< First half of the surrogate pair, in case we're receiving a Unicode character in two events
-    bool     m_mouseInside;      ///< Mouse is inside the window?
-    bool     m_fullscreen;       ///< Is the window fullscreen?
-    bool     m_cursorGrabbed;    ///< Is the mouse cursor trapped?
+    HWND     m_handle;           //!< Win32 handle of the window
+    LONG_PTR m_callback;         //!< Stores the original event callback function of the control
+    bool     m_cursorVisible;    //!< Is the cursor visible or hidden?
+    HCURSOR  m_lastCursor;       //!< Last cursor used -- this data is not owned by the window and is required to be always valid
+    HICON    m_icon;             //!< Custom icon assigned to the window
+    bool     m_keyRepeatEnabled; //!< Automatic key-repeat state for keydown events
+    Vector2u m_lastSize;         //!< The last handled size of the window
+    bool     m_resizing;         //!< Is the window being resized?
+    Uint16   m_surrogate;        //!< First half of the surrogate pair, in case we're receiving a Unicode character in two events
+    bool     m_mouseInside;      //!< Mouse is inside the window?
+    bool     m_fullscreen;       //!< Is the window fullscreen?
+    bool     m_cursorGrabbed;    //!< Is the mouse cursor trapped?
 };
 
 } // namespace priv

src/SFML/Window/WindowImpl.hpp

@@ -282,11 +282,11 @@ private:
     ////////////////////////////////////////////////////////////
     // Member data
     ////////////////////////////////////////////////////////////
-    std::queue<Event> m_events;                                              ///< Queue of available events
-    JoystickState     m_joystickStates[Joystick::Count];                     ///< Previous state of the joysticks
-    Vector3f          m_sensorValue[Sensor::Count];                          ///< Previous value of the sensors
-    float             m_joystickThreshold;                                   ///< Joystick threshold (minimum motion for "move" event to be generated)
-    float             m_previousAxes[Joystick::Count][Joystick::AxisCount];  ///< Position of each axis last time a move event triggered, in range [-100, 100]
+    std::queue<Event> m_events;                                              //!< Queue of available events
+    JoystickState     m_joystickStates[Joystick::Count];                     //!< Previous state of the joysticks
+    Vector3f          m_sensorValue[Sensor::Count];                          //!< Previous value of the sensors
+    float             m_joystickThreshold;                                   //!< Joystick threshold (minimum motion for "move" event to be generated)
+    float             m_previousAxes[Joystick::Count][Joystick::AxisCount];  //!< Position of each axis last time a move event triggered, in range [-100, 100]
 };
 
 } // namespace priv