diff --git a/include/openspace/rendering/abufferrenderer.h b/include/openspace/rendering/abufferrenderer.h index 168fcc85f1..d432adbb7c 100644 --- a/include/openspace/rendering/abufferrenderer.h +++ b/include/openspace/rendering/abufferrenderer.h @@ -92,7 +92,7 @@ private: /** * When a volume is attached or detached from the scene graph, * the resolve program needs to be recompiled. - * The #volumes vector keeps track of which volumes that can + * The #_volumes vector keeps track of which volumes that can * be rendered using the current resolve program. */ std::vector _volumes; diff --git a/include/openspace/scripting/scriptengine.h b/include/openspace/scripting/scriptengine.h index 0949ea879b..1857176ee7 100644 --- a/include/openspace/scripting/scriptengine.h +++ b/include/openspace/scripting/scriptengine.h @@ -48,15 +48,15 @@ namespace scripting { class ScriptEngine { public: /** - * This structure represents a Lua library, itself consisting of a unique \m name and - * an arbitrary number of \m functions + * This structure represents a Lua library, itself consisting of a unique #name and + * an arbitrary number of #functions */ struct LuaLibrary { /** - * This structure represents a Lua function with its \m name, \m function pointer - * \m argumentText describing the arguments this function takes, the \m helpText - * descripbing the function, and whether it should be shared in a parallel - * connection (\m parallelShared) + * This structure represents a Lua function with its #name, #function pointer + * #argumentText describing the arguments this function takes, the #helpText + * describing the function, and whether it should be shared in a parallel + * connection (#parallelShared) */ struct Function { /// The name of the function diff --git a/include/openspace/util/factorymanager.h b/include/openspace/util/factorymanager.h index 81a015639b..04903eb82b 100644 --- a/include/openspace/util/factorymanager.h +++ b/include/openspace/util/factorymanager.h @@ -34,7 +34,7 @@ namespace openspace { /** * Singleton factory class that handles a variety of ghoul::TemplateFactory%s and makes - * them available through the #addFactory and factory #methods. Each + * them available through the #addFactory and #factory methods. Each * ghoul::TemplateFactory can only be added once and can be accessed by its type. */ class FactoryManager { diff --git a/include/openspace/util/openspacemodule.h b/include/openspace/util/openspacemodule.h index 79929b509b..c8c75fc664 100644 --- a/include/openspace/util/openspacemodule.h +++ b/include/openspace/util/openspacemodule.h @@ -49,9 +49,9 @@ public: /** * Initialization method that will register a token of the form - * ${MODULE_<>} for a specific <> that is set in - * the OpenSpaceModule constructor. This method will call the internalInitialize - * method for further customization for each subclass. + * ${MODULE_\<\\>} for a specific \<\\> that + * is set in the OpenSpaceModule constructor. This method will call the + * internalInitialize method for further customization for each subclass. */ void initialize(); diff --git a/include/openspace/util/screenlog.h b/include/openspace/util/screenlog.h index b457723349..6372926672 100644 --- a/include/openspace/util/screenlog.h +++ b/include/openspace/util/screenlog.h @@ -42,9 +42,8 @@ public: using LogLevel = ghoul::logging::LogManager::LogLevel; /** - * This struct stores the incoming log entries with their \m level, \m timeString, - * \m category, \m message, and the generated \m timeStamp used for the expiry - * calculation. + * This struct stores the incoming log entries with their #level, #timeString, + * #category, #message, and the generated #timeStamp used for the expiry calculation. */ struct LogEntry { /// The ghoul::logging::LogManager::LogLevel of the log message @@ -86,9 +85,9 @@ public: /** * This method removes all the stored LogEntry%s that have expired, calculated by - * their timeStamp and the \m _timeToLive value. + * their timeStamp and the #_timeToLive value. * \post All entries retrieved by the #entries function have a timeStamp - * that is lower than the current time + \m _timeToLive. The current time used is the + * that is lower than the current time + #_timeToLive. The current time used is the * time when this method was last called */ void removeExpiredEntries(); diff --git a/include/openspace/util/spicemanager.h b/include/openspace/util/spicemanager.h index 3e7cb58377..bc18dd88bc 100644 --- a/include/openspace/util/spicemanager.h +++ b/include/openspace/util/spicemanager.h @@ -240,7 +240,7 @@ public: * \return true if the function succeeded, false otherwise * \throws SpiceException If \p body does not name a valid SPICE object. * \pre \p body must not be empty. - * \pre \item must not be empty. + * \pre \p item must not be empty. * \sa http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/bodfnd_c.html */ bool hasValue(const std::string& body, const std::string& item) const; @@ -298,7 +298,7 @@ public: * this body * \param value The value that should be retrieved, this value is case-sensitive * \param v The destination for the retrieved value - * \throws SpiceException If the \p body does not name a valid body, \t value + * \throws SpiceException If the \p body does not name a valid body, \p value * is not a valid item for the \p body or the retrieved value is not a single value. * \pre \p body must not be empty. * \pre \p value must not be empty. @@ -317,7 +317,7 @@ public: * this body * \param value The value that should be retrieved, this value is case-sensitive * \param v The destination for the retrieved value - * \throws SpiceException If the \p body does not name a valid body, \t value + * \throws SpiceException If the \p body does not name a valid body, \p value * is not a valid item for the \p body or the retrieved value is not a two-component * value. * \pre \p body must not be empty. @@ -338,7 +338,7 @@ public: * this body * \param value The value that should be retrieved, this value is case-sensitive * \param v The destination for the retrieved value - * \throws SpiceException If the \p body does not name a valid body, \t value + * \throws SpiceException If the \p body does not name a valid body, \p value * is not a valid item for the \p body or the retrieved value is not a three-component * value. * \pre \p body must not be empty. @@ -358,7 +358,7 @@ public: * this body * \param value The value that should be retrieved, this value is case-sensitive * \param v The destination for the retrieved value - * \throws SpiceException If the \p body does not name a valid body, \t value + * \throws SpiceException If the \p body does not name a valid body, \p value * is not a valid item for the \p body or the retrieved value is not a four-component * value. * \pre \p body must not be empty. @@ -379,7 +379,7 @@ public: * \param value The value that should be retrieved, this value is case-sensitive * \param v The destination for the retrieved value. The vector must be * preallocated to the correct size of components that should be retrieved - * \throws SpiceException If the \p body does not name a valid body, \t value + * \throws SpiceException If the \p body does not name a valid body, \p value * is not a valid item for the \p body or the retrieved value does not contain the * correct number of components * value. @@ -402,7 +402,7 @@ public: * available through all loaded kernels, if the craft is not supported by any of the * loaded kernel, or if the provided \p craftTicks is not a valid tick time for the * specific spacecraft - * \pre \craftIdCode must not be empty + * \pre \p craft must not be empty */ double spacecraftClockToET(const std::string& craft, double craftTicks); @@ -416,19 +416,19 @@ public: * \throws SpiceException If \p timeString is not a valid timestring according * to the str2et_c function (see the Particulars section of the linked * webpage). - * \pre \t timeString must not be empty + * \pre \p timeString must not be empty * \sa http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/str2et_c.html */ double ephemerisTimeFromDate(const std::string& timeString) const; /** * Converts the passed \p ephemerisTime into a human-readable date string with a - * specific \t format. + * specific \p formatString. * \param ephemerisTime The ephemeris time, that is the number of TDB seconds past the * J2000 epoch - * \param format The format string describing the output format + * \param formatString The format string describing the output format * \return The destination for the converted date. - * \pre \t format must not be empty + * \pre \p formatString must not be empty * \sa http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/timout_c.html */ std::string dateFromEphemerisTime(double ephemerisTime, @@ -707,7 +707,7 @@ public: /// The shape of the returned field of view Shape shape; - /// The name of the reference frame in which the \m bounds are defined + /// The name of the reference frame in which the #bounds are defined std::string frameName; /// The direction towards the center of the field of view @@ -744,7 +744,7 @@ public: /// The structure retuned by the #terminatorEllipse method struct TerminatorEllipseResult { - /// The vector from the target body at \m targetEphemerisTime to the observer at + /// The vector from the target body at #targetEphemerisTime to the observer at /// the original time glm::dvec3 observerPosition; @@ -831,7 +831,7 @@ private: * by using mainly the ckcov_c and ckobj_c functions. * http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ckobj_c.html , * http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/ckcov_c.html - * \param filePath The path to the kernel that should be examined + * \param path The path to the kernel that should be examined * \return true if the operation was successful * \pre \p path must be nonempty and be an existing file * \post Coverage times are stored only if loading was successful @@ -843,7 +843,7 @@ private: * by using mainly the spkcov_c and spkobj_c functions. * http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/spkobj_c.html , * http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/spkcov_c.html - * \param filePath The path to the kernel that should be examined + * \param path The path to the kernel that should be examined * \return true if the operation was successful * \pre \p path must be nonempty and be an existing file * \post Coverage times are stored only if loading was successful diff --git a/src/util/spicemanager.cpp b/src/util/spicemanager.cpp index 824c71f43e..08310d30da 100644 --- a/src/util/spicemanager.cpp +++ b/src/util/spicemanager.cpp @@ -258,7 +258,7 @@ void SpiceManager::unloadKernel(KernelHandle kernelId) { } } -void SpiceManager::unloadKernel(string filePath) { +void SpiceManager::unloadKernel(std::string filePath) { ghoul_assert(!filePath.empty(), "Empty filename"); string path = absPath(filePath); @@ -317,11 +317,11 @@ bool SpiceManager::hasCkCoverage(const string& frame, double et) const { return false; } -bool SpiceManager::hasValue(int naifId, const string& item) const { +bool SpiceManager::hasValue(int naifId, const std::string& item) const { return bodfnd_c(naifId, item.c_str()); } -bool SpiceManager::hasValue(const string& body, const string& item) const { +bool SpiceManager::hasValue(const std::string& body, const std::string& item) const { ghoul_assert(!body.empty(), "Empty body"); ghoul_assert(!item.empty(), "Empty item"); @@ -329,7 +329,7 @@ bool SpiceManager::hasValue(const string& body, const string& item) const { return hasValue(id, item); } -int SpiceManager::naifId(const string& body) const { +int SpiceManager::naifId(const std::string& body) const { ghoul_assert(!body.empty(), "Empty body"); SpiceBoolean success; @@ -340,7 +340,7 @@ int SpiceManager::naifId(const string& body) const { return id; } -bool SpiceManager::hasNaifId(const string& body) const { +bool SpiceManager::hasNaifId(const std::string& body) const { ghoul_assert(!body.empty(), "Empty body"); SpiceBoolean success; @@ -350,7 +350,7 @@ bool SpiceManager::hasNaifId(const string& body) const { return success; } -int SpiceManager::frameId(const string& frame) const { +int SpiceManager::frameId(const std::string& frame) const { ghoul_assert(!frame.empty(), "Empty frame"); SpiceInt id; @@ -360,7 +360,7 @@ int SpiceManager::frameId(const string& frame) const { return id; } -bool SpiceManager::hasFrameId(const string& frame) const { +bool SpiceManager::hasFrameId(const std::string& frame) const { ghoul_assert(!frame.empty(), "Empty frame"); SpiceInt id; @@ -368,7 +368,7 @@ bool SpiceManager::hasFrameId(const string& frame) const { return id != 0; } -void getValueInternal(const string& body, const string& value, int size, +void getValueInternal(const std::string& body, const std::string& value, int size, double* v) { ghoul_assert(!body.empty(), "Empty body"); @@ -386,37 +386,39 @@ void getValueInternal(const string& body, const string& value, int size, ); } -void SpiceManager::getValue(const string& body, const string& value, double& v) const { +void SpiceManager::getValue(const std::string& body, const std::string& value, + double& v) const +{ getValueInternal(body, value, 1, &v); } -void SpiceManager::getValue(const string& body, const string& value, +void SpiceManager::getValue(const std::string& body, const std::string& value, glm::dvec2& v) const { getValueInternal(body, value, 2, glm::value_ptr(v)); } -void SpiceManager::getValue(const string& body, const string& value, +void SpiceManager::getValue(const std::string& body, const std::string& value, glm::dvec3& v) const { getValueInternal(body, value, 3, glm::value_ptr(v)); } -void SpiceManager::getValue(const string& body, const string& value, - glm::dvec4& v) const +void SpiceManager::getValue(const std::string& body, const std::string& value, + glm::dvec4& v) const { getValueInternal(body, value, 4, glm::value_ptr(v)); } -void SpiceManager::getValue(const string& body, const string& value, - std::vector& v) const +void SpiceManager::getValue(const std::string& body, const std::string& value, + std::vector& v) const { ghoul_assert(!v.empty(), "Array for values has to be preallocaed"); getValueInternal(body, value, v.size(), v.data()); } -double SpiceManager::spacecraftClockToET(const string& craft, double craftTicks) { +double SpiceManager::spacecraftClockToET(const std::string& craft, double craftTicks) { ghoul_assert(!craft.empty(), "Empty craft"); int craftId = naifId(craft); @@ -457,9 +459,10 @@ string SpiceManager::dateFromEphemerisTime(double ephemerisTime, } -glm::dvec3 SpiceManager::targetPosition(const string& target, const string& observer, - const string& referenceFrame, AberrationCorrection aberrationCorrection, - double ephemerisTime, double& lightTime) const +glm::dvec3 SpiceManager::targetPosition(const std::string& target, + const std::string& observer, const std::string& referenceFrame, + AberrationCorrection aberrationCorrection, double ephemerisTime, + double& lightTime) const { ghoul_assert(!target.empty(), "Target is not empty"); ghoul_assert(!observer.empty(), "Observer is not empty"); @@ -518,8 +521,9 @@ glm::dvec3 SpiceManager::targetPosition(const string& target, const string& obse } } -glm::dmat3 SpiceManager::frameTransformationMatrix(const string& from, const string& to, - double ephemerisTime) const +glm::dmat3 SpiceManager::frameTransformationMatrix(const std::string& from, + const std::string& to, + double ephemerisTime) const { ghoul_assert(!from.empty(), "From must not be empty"); ghoul_assert(!to.empty(), "To must not be empty"); @@ -545,8 +549,8 @@ glm::dmat3 SpiceManager::frameTransformationMatrix(const string& from, const str } SpiceManager::SurfaceInterceptResult SpiceManager::surfaceIntercept( - const string& target, const string& observer, const string& fovFrame, - const string& referenceFrame, AberrationCorrection aberrationCorrection, + const std::string& target, const std::string& observer, const std::string& fovFrame, + const std::string& referenceFrame, AberrationCorrection aberrationCorrection, double ephemerisTime, const glm::dvec3& directionVector) const { ghoul_assert(!target.empty(), "Target must not be empty"); @@ -585,8 +589,9 @@ SpiceManager::SurfaceInterceptResult SpiceManager::surfaceIntercept( return result; } -bool SpiceManager::isTargetInFieldOfView(const string& target, const string& observer, - const string& referenceFrame, const string& instrument, FieldOfViewMethod method, +bool SpiceManager::isTargetInFieldOfView(const std::string& target, + const std::string& observer, const std::string& referenceFrame, + const std::string& instrument, FieldOfViewMethod method, AberrationCorrection aberrationCorrection, double& ephemerisTime) const { ghoul_assert(!target.empty(), "Target must not be empty"); @@ -614,8 +619,8 @@ bool SpiceManager::isTargetInFieldOfView(const string& target, const string& obs return visible == SPICETRUE; } -bool SpiceManager::isTargetInFieldOfView(const string& target, const string& observer, - const string& instrument, FieldOfViewMethod method, +bool SpiceManager::isTargetInFieldOfView(const std::string& target, + const std::string& observer, const std::string& instrument, FieldOfViewMethod method, AberrationCorrection aberrationCorrection, double& ephemerisTime) const { return isTargetInFieldOfView( @@ -629,8 +634,8 @@ bool SpiceManager::isTargetInFieldOfView(const string& target, const string& obs ); } -SpiceManager::TargetStateResult SpiceManager::targetState(const string& target, - const string& observer, const string& referenceFrame, +SpiceManager::TargetStateResult SpiceManager::targetState(const std::string& target, + const std::string& observer, const std::string& referenceFrame, AberrationCorrection aberrationCorrection, double ephemerisTime) const { ghoul_assert(!target.empty(), "Target must not be empty"); @@ -684,8 +689,8 @@ SpiceManager::TransformMatrix SpiceManager::stateTransformMatrix(const string& f return m; } -glm::dmat3 SpiceManager::positionTransformMatrix(const string& fromFrame, - const string& toFrame, double ephemerisTime) const +glm::dmat3 SpiceManager::positionTransformMatrix(const std::string& fromFrame, + const std::string& toFrame, double ephemerisTime) const { ghoul_assert(!fromFrame.empty(), "fromFrame must not be empty"); ghoul_assert(!toFrame.empty(), "toFrame must not be empty"); @@ -708,8 +713,8 @@ glm::dmat3 SpiceManager::positionTransformMatrix(const string& fromFrame, return glm::transpose(result); } -glm::dmat3 SpiceManager::positionTransformMatrix(const string& fromFrame, - const string& toFrame, double ephemerisTimeFrom, double ephemerisTimeTo) const +glm::dmat3 SpiceManager::positionTransformMatrix(const std::string& fromFrame, + const std::string& toFrame, double ephemerisTimeFrom, double ephemerisTimeTo) const { ghoul_assert(!fromFrame.empty(), "fromFrame must not be empty"); ghoul_assert(!toFrame.empty(), "toFrame must not be empty"); @@ -731,7 +736,8 @@ glm::dmat3 SpiceManager::positionTransformMatrix(const string& fromFrame, return glm::transpose(result); } -SpiceManager::FieldOfViewResult SpiceManager::fieldOfView(const string& instrument) const +SpiceManager::FieldOfViewResult +SpiceManager::fieldOfView(const std::string& instrument) const { ghoul_assert(!instrument.empty(), "Instrument must not be empty"); return fieldOfView(naifId(instrument)); @@ -780,8 +786,8 @@ SpiceManager::FieldOfViewResult SpiceManager::fieldOfView(int instrument) const } SpiceManager::TerminatorEllipseResult SpiceManager::terminatorEllipse( - const string& target, const string& observer, const string& frame, - const string& lightSource, TerminatorType terminatorType, + const std::string& target, const std::string& observer, const std::string& frame, + const std::string& lightSource, TerminatorType terminatorType, AberrationCorrection aberrationCorrection, double ephemerisTime, int numberOfTerminatorPoints) {