mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-02-26 06:49:09 -06:00
Update Doxygen (#2537)
* Modernizing Doxygen * Remove warnings for Doxygen
This commit is contained in:
@@ -39,8 +39,8 @@ namespace openspace::scripting {
|
||||
struct LuaLibrary {
|
||||
/**
|
||||
* This structure represents a Lua function with its #name, #function pointer
|
||||
* #argumentText describing the arguments this function takes, and the the #helpText
|
||||
* describing the function.
|
||||
* #arguments describe the arguments this function takes, and the #helpText describing
|
||||
* the function.
|
||||
*/
|
||||
struct Function {
|
||||
/// The name of the function
|
||||
|
||||
@@ -46,7 +46,7 @@ namespace openspace::scripting {
|
||||
* executing scripts (#runScript and #runScriptFile). Before usage, it has to be
|
||||
* #initialize%d and #deinitialize%d. New ScriptEngine::Library%s consisting of
|
||||
* ScriptEngine::Library::Function%s have to be added which can then be called using the
|
||||
* <code>openspace</code> namespac prefix in Lua. The same functions can be exposed to
|
||||
* `openspace` namespace prefix in Lua. The same functions can be exposed to
|
||||
* other Lua states by passing them to the #initializeLuaState method.
|
||||
*/
|
||||
class ScriptEngine : public Syncable, public DocumentationGenerator {
|
||||
|
||||
@@ -45,7 +45,7 @@ namespace openspace::scripting {
|
||||
struct LuaLibrary;
|
||||
|
||||
/**
|
||||
* Maintains an ordered list of <code>ScheduledScript</code>s and provides a simple
|
||||
* Maintains an ordered list of `ScheduledScript`s and provides a simple
|
||||
* interface for retrieveing scheduled scripts
|
||||
*/
|
||||
class ScriptScheduler : public properties::PropertyOwner {
|
||||
@@ -65,9 +65,10 @@ public:
|
||||
};
|
||||
|
||||
/**
|
||||
* Load a schedule from a ghoul::Dictionary \p dictionary and adds the
|
||||
* Load a schedule from a ghoul::Dictionary \p scheduledScripts and adds the
|
||||
* ScheduledScript%s to the list of stored scripts.
|
||||
* \param dictionary Dictionary to read
|
||||
*
|
||||
* \param scheduledScripts The scripts that should be loaded
|
||||
* \throw SpecificationError If the dictionary does not adhere to the Documentation as
|
||||
* specified in the openspace::Documentation function
|
||||
*/
|
||||
@@ -82,35 +83,15 @@ public:
|
||||
/**
|
||||
* Removes all scripts for the schedule.
|
||||
*
|
||||
* \param An int that specifies which group to clear.
|
||||
* If none given then all scripts is cleared from the schedule.
|
||||
* \param group An int that specifies which group to clear. If none given then all
|
||||
* scripts
|
||||
* is cleared from the schedule.
|
||||
*/
|
||||
void clearSchedule(std::optional<int> group = std::nullopt);
|
||||
|
||||
/**
|
||||
* Progresses the script schedulers time and returns all scripts that has been
|
||||
* scheduled to run between \param newTime and the time provided in the last invocation
|
||||
* of this method.
|
||||
*
|
||||
* \param newTime_simulation A j2000 time value specifying the new time stamp that
|
||||
* the script scheduler should progress to.
|
||||
* \param newTime_application The seconds elapsed since the application started
|
||||
*
|
||||
* \returns the ordered queue of scripts .
|
||||
*/
|
||||
// std::queue<std::string> progressTo(double newTime);
|
||||
|
||||
/**
|
||||
* See <code>progressTo(double newTime)</code>.
|
||||
*
|
||||
* \param timeStr A string specifying the a new time stamp that the
|
||||
* scripts scheduler should progress to.
|
||||
*/
|
||||
// std::queue<std::string> progressTo(const std::string& timeStr);
|
||||
|
||||
/**
|
||||
* Progresses the script schedulers time and returns all scripts that has been
|
||||
* scheduled to run between \param newTime and the time provided in the last invocation
|
||||
* scheduled to run between \p newTime and the time provided in the last invocation
|
||||
* of this method.
|
||||
*
|
||||
* \param newTime A j2000 time value specifying the new time stamp that
|
||||
|
||||
Reference in New Issue
Block a user