mirror/OpenSpace
1
0
Fork 0
mirror of https://github.com/OpenSpace/OpenSpace.git synced 2026-03-09 14:58:37 -05: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

35
include/openspace/engine/openspaceengine.h
View File

@@ -51,15 +51,17 @@ class Scene;
namespace scripting { struct LuaLibrary; }
// Structure that is responsible for the delayed shutdown of the application
/**
* Structure that is responsible for the delayed shutdown of the application.
*/
struct ShutdownInformation {
// Whether the application is currently in shutdown mode (i.e. counting down the
// timer and closing it at '0'
/// Whether the application is currently in shutdown mode (i.e. counting down the
/// timer and closing it at '0'
bool inShutdown = false;
// Total amount of time the application will wait before actually shutting down
/// Total amount of time the application will wait before actually shutting down
float waitTime = 0.f;
// Current state of the countdown; if it reaches '0', the application will
// close
/// Current state of the countdown; if it reaches '0', the application will
/// close
float timer = 0.f;
};
@@ -73,9 +75,11 @@ struct CommandlineArguments {
class OpenSpaceEngine : public properties::PropertyOwner {
public:
// A mode that specifies which part of the system is currently in control.
// The mode can be used to limit certain features, like setting time, navigation
// or triggering scripts
/**
* A mode that specifies which part of the system is currently in control. The mode
* can be used to limit certain features, like setting time, navigation or triggering
* scripts.
*/
enum class Mode {
UserControl = 0,
SessionRecordingPlayback,
@@ -180,7 +184,8 @@ private:
* Sets the camera position using the time contents of a profile. The function will
* set an absolute position or a go-to-geolocation command using the globebrowsing
* module.
* \param p The Profile to be read.
*
* \param p The Profile to be read
*/
void setCameraFromProfile(const Profile& p);
@@ -188,21 +193,21 @@ void setCameraFromProfile(const Profile& p);
* Reads a list of modules from a profile, and executes scripts based on whether or
* not the corresponding module is loaded.
*
* \param p The Profile to be read.
* \param p The Profile to be read
*/
void setModulesFromProfile(const Profile& p);
/**
* Registers actions from the contents of a profile.
*
* \param p The Profile to be read.
* \param p The Profile to be read
*/
void setActionsFromProfile(const Profile& p);
/**
* Registers keybindings from the contents of a profile.
*
* \param p The Profile to be read.
* \param p The Profile to be read
*/
void setKeybindingsFromProfile(const Profile& p);
@@ -211,7 +216,7 @@ void setKeybindingsFromProfile(const Profile& p);
* If any nodes are listed, a script to mark these will be queued with the
* script engine.
*
* \param p The Profile to be read.
* \param p The Profile to be read
*/
void setMarkInterestingNodesFromProfile(const Profile& p);
@@ -220,7 +225,7 @@ void setMarkInterestingNodesFromProfile(const Profile& p);
* at the end of the initialization. Any openspace lua commands are allowed,
* and will be added to the script queue.
*
* \param p The Profile to be read.
* \param p The Profile to be read
*/
void setAdditionalScriptsFromProfile(const Profile& p);