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

Doxygen style overhaul (#2954)

Browse Source 
Reformatting the existing Doxygen comments to be unified
This commit is contained in:
Alexander Bock
2023-11-20 23:39:17 +01:00
committed by GitHub
parent 4ee078502b
commit 7db7c40841
163 changed files with 2266 additions and 2035 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/openspace/network/messagestructures.h
View File

@@ -66,7 +66,7 @@ struct CameraKeyframe {
double _timestamp = 0.0;
void serialize(std::vector<char> &buffer) const {
void serialize(std::vector<char>& buffer) const {
// Add position
buffer.insert(
buffer.end(),

22
include/openspace/network/messagestructureshelper.h
View File

@@ -30,25 +30,27 @@
namespace openspace::datamessagestructures {
/**
* Method that creates a CameraKeyframe object and populates
* it with the current properties of the camera from the navigation handler.
* \returns CameraKeyframe with current state from NavigationHandler
* Method that creates a CameraKeyframe object and populates it with the current
* properties of the camera from the navigation handler.
*
* \return CameraKeyframe with current state from NavigationHandler
*/
CameraKeyframe generateCameraKeyframe();
/**
* Method that creates a TimeKeyframe object and populates
* it with the current time values from the application time manager.
* \returns TimeKeyframe The time keyframe
* Method that creates a TimeKeyframe object and populates it with the current time values
* from the application time manager.
*
* \return TimeKeyframe The time keyframe
*/
TimeKeyframe generateTimeKeyframe();
/**
* Method that creates a ScriptMessage object from a given script
* string, and populates the ScriptMessage with the script and timestamp
* of the current application time.
* Method that creates a ScriptMessage object from a given script string, and populates
* the ScriptMessage with the script and timestamp of the current application time.
*
* \param script The script to execute in std::string form
* \returns ScriptMessage The ScriptMessage data structure with script
* \return ScriptMessage The ScriptMessage data structure with script
*/
ScriptMessage generateScriptMessage(std::string script);

6
include/openspace/network/parallelpeer.h
View File

@@ -66,9 +66,9 @@ public:
double latencyStandardDeviation() const;
/**
* Returns the Lua library that contains all Lua functions available to affect the
* remote OS parallel connection.
*/
* Returns the Lua library that contains all Lua functions available to affect the
* remote OS parallel connection.
*/
static scripting::LuaLibrary luaLibrary();
ParallelConnection::Status status();
int nConnections();