Update Doxygen (#2537)

* Modernizing Doxygen
* Remove warnings for Doxygen

include/openspace/interaction/joystickinputstate.h

@@ -54,7 +54,7 @@ enum class JoystickAction : uint8_t {
  * The input state of a single joystick.
  */
 struct JoystickInputState {
-    /// Marks whether this joystick is connected. If this value is \c false, all other
+    /// Marks whether this joystick is connected. If this value is `false`, all other
     /// members of this struct are undefined
     bool isConnected = false;
 
@@ -120,7 +120,7 @@ struct JoystickInputStates : public std::array<JoystickInputState, MaxJoysticks>
      * \param joystickName The name of the joystick, if empty all joysticks are combined
      * \param button The button that is to be checked
      * \param action The action which is checked for each button
-     * \return \c true if there is at least one joystick whose \param button is in the
+     * \return `true` if there is at least one joystick whose \p button is in the
      *         \p action state
      *
      * \pre \p button must be 0 or positive

include/openspace/interaction/sessionrecording.h

@@ -174,9 +174,7 @@ public:
      * Starts a recording session, which will save data to the provided filename
      * in ASCII data format until recording is stopped using stopRecording() method.
      *
-     * \param filename file saved with recorded keyframes.
-     *
-     * \return \c true if recording to file starts without errors
+     * \param dataMode The format in which the session recording is stored
      */
     void setRecordDataFormat(DataMode dataMode);
 
@@ -206,7 +204,7 @@ public:
      * \param loop if true then the file will playback in loop mode, continuously
      *             looping back to the beginning until it is manually stopped
      *
-     * \return \c true if recording to file starts without errors
+     * \return `true` if recording to file starts without errors
      */
     bool startPlayback(std::string& filename, KeyframeTimeRef timeMode,
         bool forceSimTimeAtStart, bool loop);
@@ -220,7 +218,7 @@ public:
     /**
      * Returns playback pause status.
      *
-     * \return \c true if playback is paused
+     * \return `true` if playback is paused
      */
     bool isPlaybackPaused();
 
@@ -303,7 +301,7 @@ public:
      *
      * \param callback function handle for the callback
      */
-    void removeStateChangeCallback(CallbackHandle handle);
+    void removeStateChangeCallback(CallbackHandle callback);
 
     /**
      * Provides list of available playback files.
@@ -492,7 +490,7 @@ public:
     /**
      * Reads header information from a session recording file
      *
-     * \param stringstream reference to ifstream that contains the session recording file
+     * \param stream reference to ifstream that contains the session recording file
      *        data
      * \param readLen_chars number of characters to be read, which may be the expected
      *        length of the header line, or an arbitrary number of characters within it
@@ -556,7 +554,7 @@ public:
      * header version number). Accepts a relative path (currently from task runner dir)
      * rather than a path assumed to be relative to ${RECORDINGS}.
      *
-     * \param filename name of the file to convert
+     * \param filenameRelative name of the file to convert
      */
     void convertFileRelativePath(std::string filenameRelative);
 

include/openspace/interaction/websocketinputstate.h

@@ -59,7 +59,7 @@ struct WebsocketInputState {
     /// The maximum number of supported buttons
     static constexpr int MaxButtons = 32;
 
-    /// Marks whether this websocket is connected. If this value is \c false, all other
+    /// Marks whether this websocket is connected. If this value is `false`, all other
     /// members of this struct are undefined
     bool isConnected = false;
 
@@ -69,12 +69,12 @@ struct WebsocketInputState {
     /// The number of axes that this websocket supports
     int nAxes = 0;
     /// The values for each axis. Each value is in the range [-1, 1]. Only the first
-    /// \c nAxes values are defined values, the rest are undefined
+    /// `nAxes` values are defined values, the rest are undefined
     std::array<float, MaxAxes> axes;
 
     /// The number of buttons that this websocket possesses
     int nButtons = 0;
-    /// The status of each button. Only the first \c nButtons values are defined, the rest
+    /// The status of each button. Only the first `nButtons` values are defined, the rest
     /// are undefined
     std::array<WebsocketAction, MaxButtons> buttons;
 };
@@ -104,7 +104,7 @@ struct WebsocketInputStates : public std::unordered_map<size_t, WebsocketInputSt
      *
      * \param button The button that is to be checked
      * \param action The action which is checked for each button
-     * \return \c true if there is at least one websocket whose \param button is in the
+     * \return `true` if there is at least one websocket whose \p button is in the
      *         \p action state
      *
      * \pre \p button must be 0 or positive