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

9
include/openspace/engine/globalscallbacks.h
View File

@@ -66,11 +66,10 @@ inline std::vector<std::function<void(TouchInput)>>* touchExit;
/**
* If the framerate becomes slow, Chromium Embedded Framework (used in Web Browser Module)
* needs to perform its message loop work more frequently than once per frame. If this
* method is not called frequently enough, the GUI will become much less responsive.
* A future more long-term may decouple the browser's message work loop from the main
* render loop altogehter using a separate thread.
* Currently, this method is called from within the RenderEngine,
* between calls to individual renderables.
* method is not called frequently enough, the GUI will become much less responsive. A
* future more long-term may decouple the browser's message work loop from the main render
* loop altogehter using a separate thread. Currently, this method is called from within
* the RenderEngine, between calls to individual renderables.
*/
extern void (*webBrowserPerformanceHotfix)();

12
include/openspace/engine/logfactory.h
View File

@@ -43,12 +43,14 @@ namespace documentation { struct Documentation; }
* logfile should be created. Both logs can be customized using the `Append`,
* `TimeStamping`, `DateStamping`, `CategoryStamping`, and `LogLevelStamping` values.
*
* \param dictionary The dictionary from which the ghoul::logging::Log should be created
* \param dictionary The dictionary from which the ghoul::logging::Log should be created
* \return The created ghoul::logging::Log
* \post The return value will not be `nullptr`
* \throw ghoul::RuntimeError If there was an error creating the ghoul::logging::Log
* \sa ghoul::logging::TextLog
* \sa ghoul::logging::HTMLLog
*
* \post The return value will not be `nullptr`
* \throw ghoul::RuntimeError If there was an error creating the ghoul::logging::Log
*
* \sa ghoul::logging::TextLog
* \sa ghoul::logging::HTMLLog
*/
std::unique_ptr<ghoul::logging::Log> createLog(const ghoul::Dictionary& dictionary);

21
include/openspace/engine/moduleengine.h
View File

@@ -45,9 +45,9 @@ namespace scripting { struct LuaLibrary; }
* The ModuleEngine is the central repository for registering and accessing
* OpenSpaceModule for the current application run. By initializing (#initialize) the
* ModuleEngine, the default set of OpenSpaceModule%s as generated by CMake in the
* `moduleregistration.h` file is automatically registered and created.
* Additional OpenSpaceModule%s can be registered with the #registerModule function, which
* will internally call the OpenSpaceModule::initialize method.
* `moduleregistration.h` file is automatically registered and created. Additional
* OpenSpaceModule%s can be registered with the #registerModule function, which will
* internally call the OpenSpaceModule::initialize method.
*/
class ModuleEngine : public properties::PropertyOwner {
public:
@@ -55,11 +55,10 @@ public:
/**
* Registers all of the OpenSpaceModule%s which are created by the CMake configuration
* and stored in the `moduleregistration.h` file. For all of those modules
* the OpenSpaceModule::initialize method with will called.
* and stored in the `moduleregistration.h` file. For all of those modules the
* OpenSpaceModule::initialize method with will called.
*
* \throw ghoul::RuntimeError If two modules in the default modules have the same
* name
* \throw ghoul::RuntimeError If two modules in the default modules have the same name
*/
void initialize(const std::map<std::string, ghoul::Dictionary>& moduleConfigurations);
@@ -104,7 +103,7 @@ public:
* to have the public static member variable `name` which must be equal to
* the name of the module used in its constructor.
*
* \return a pointer to the module of the given subclass
* \return A pointer to the module of the given subclass
*/
template <class ModuleSubClass>
ModuleSubClass* module() const;
@@ -118,9 +117,9 @@ public:
ghoul::systemcapabilities::Version requiredOpenGLVersion() const;
/**
* Returns the Lua library that contains all Lua functions available to affect the
* modules.
*/
* Returns the Lua library that contains all Lua functions available to affect the
* modules.
*/
static scripting::LuaLibrary luaLibrary();
private:

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);

37
include/openspace/engine/syncengine.h
View File

@@ -36,72 +36,71 @@ namespace openspace {
class Syncable;
/**
* Manages a collection of `Syncable`s and ensures they are synchronized
* over SGCT nodes. Encoding/Decoding order is handles internally.
* Manages a collection of `Syncable`s and ensures they are synchronized over SGCT nodes.
* Encoding/Decoding order is handles internally.
*/
class SyncEngine {
public:
BooleanType(IsMaster);
/**
* Creates a new SyncEngine which a buffer size of \p syncBufferSize
* Creates a new SyncEngine which a buffer size of \p syncBufferSize.
*
* \pre syncBufferSize must be bigger than 0
*/
SyncEngine(unsigned int syncBufferSize);
/**
* Encodes all added Syncables in the injected `SyncBuffer`.
* This method is only called on the SGCT master node
* Encodes all added Syncables in the injected `SyncBuffer`. This method is only
* called on the SGCT master node.
*/
std::vector<std::byte> encodeSyncables();
/**
* Decodes the `SyncBuffer` into the added Syncables.
* This method is only called on the SGCT client nodes
* Decodes the `SyncBuffer` into the added Syncables. This method is only called on
* the SGCT client nodes.
*/
void decodeSyncables(std::vector<std::byte> data);
/**
* Invokes the presync method of all added Syncables
* Invokes the presync method of all added Syncables.
*/
void preSynchronization(IsMaster isMaster);
/**
* Invokes the postsync method of all added Syncables
* Invokes the postsync method of all added Syncables.
*/
void postSynchronization(IsMaster isMaster);
/**
* Add a Syncable to be synchronized over the SGCT cluster.
* \pre syncable must not be nullptr
*
* \pre syncable must not be `nullptr`
*/
void addSyncable(Syncable* syncable);
/**
* Add multiple Syncables to be synchronized over the SGCT cluster
* Add multiple Syncables to be synchronized over the SGCT cluster.
*
* \pre syncables must not contain any nullptr
*/
void addSyncables(const std::vector<Syncable*>& syncables);
/**
* Remove a Syncable from being synchronized over the SGCT cluster
* Remove a Syncable from being synchronized over the SGCT cluster.
*/
void removeSyncable(Syncable* syncable);
/**
* Remove multiple Syncables from being synchronized over the SGCT cluster
* Remove multiple Syncables from being synchronized over the SGCT cluster.
*/
void removeSyncables(const std::vector<Syncable*>& syncables);
private:
/**
* Vector of Syncables. The vectors ensures consistent encode/decode order
*/
/// Vector of Syncables. The vectors ensures consistent encode/decode order.
std::vector<Syncable*> _syncables;
/**
* Databuffer used in encoding/decoding
*/
/// Databuffer used in encoding/decoding
SyncBuffer _syncBuffer;
};