mirror/OpenSpace
1
0
Fork 0
mirror of https://github.com/OpenSpace/OpenSpace.git synced 2026-01-06 03:29:44 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update Doxygen (#2537)

Browse Source 
* Modernizing Doxygen
* Remove warnings for Doxygen
This commit is contained in:
Alexander Bock
2023-03-06 15:41:24 -07:00
committed by GitHub
parent ebf0454da2
commit a711591c09
83 changed files with 3309 additions and 1758 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/openspace/interaction/websocketinputstate.h
View File

@@ -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