From 7226b23cc0acedb2f0111e5986421570b1fc0e75 Mon Sep 17 00:00:00 2001 From: Alexander Bock Date: Tue, 9 Dec 2014 19:11:49 +0100 Subject: [PATCH] Fixing doxygen warnings --- ext/ghoul | 2 +- include/openspace/util/spicemanager.h | 35 +++------------------------ include/openspace/util/time.h | 2 +- 3 files changed, 6 insertions(+), 33 deletions(-) diff --git a/ext/ghoul b/ext/ghoul index c272222c4d..439a011434 160000 --- a/ext/ghoul +++ b/ext/ghoul @@ -1 +1 @@ -Subproject commit c272222c4d3b0de1e0740ea87277b841a3393cf6 +Subproject commit 439a011434435a1777e013a2b093ccb36a171365 diff --git a/include/openspace/util/spicemanager.h b/include/openspace/util/spicemanager.h index 7eb56e5c05..3752241121 100644 --- a/include/openspace/util/spicemanager.h +++ b/include/openspace/util/spicemanager.h @@ -111,7 +111,7 @@ public: /** * Determines whether values exist for some item for any - * code>body in the kernel pool by passing it to the bodfnd_c + * body in the kernel pool by passing it to the bodfnd_c * function. * http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/bodfnd_c.html * \param body The name of the body that should be sampled @@ -465,8 +465,9 @@ public: * surface point on a body with the NAIF ID of id to rectangular * coordinates. For further details, refer to * http://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/srfrec_c.html. - * \param body The body on which the longitude and latitude - * are defined. This body needs to have a defined radius for this function to work + * \param id The identifier of the body on which the longitude and + * latitude are defined. This body needs to have a defined radius for + * this function to work. * \param longitude The longitude of the point on the body in radians * \param latitude The latitude of the point on the body in radians * \param coordinates The output containing the rectangular coordinates of the point @@ -524,34 +525,6 @@ public: double& targetEphemerisTime, glm::dvec3& vectorToSurfacePoint) const; - /** - * Computes the rectangular coordinates of the sub-solar point on - * a target body at a specified epoch, optionally corrected for - * light time and stellar aberration. - * For further details, please refer to 'subslr_c ' in SPICE Docummentation - * - * \param computationMethod Computation method. - * \param target Name of target body. - * \param ephemeris Epoch in ephemeris seconds past J2000 TDB. - * \param bodyFixedFrame Body-fixed, body-centered target body frame. - * \param aberrationCorrection Aberration correction. - * \param observer Name of observing body. - * \param subObserverPoint Sub-observer point on the target body. - * \param targetEpoch Sub-observer point epoch. - * \param observerToSubObserverVec Vector from observer to sub-observer point. - * \return Whether the function succeeded or not - */ - //bool getSubSolarPoint(std::string target, - // std::string computationMethod, - // - // double ephemeris, - // std::string bodyFixedFrame, - // std::string aberrationCorrection, - // - // glm::dvec3& subSolarPoint, - // double& targetEpoch, - // glm::dvec3& vectorToSurfacePoint) const; - /** * This method checks if one of the previous SPICE methods has failed. If it has, the * errorMessage is used to log an error along with the original SPICE diff --git a/include/openspace/util/time.h b/include/openspace/util/time.h index 910cffa8c7..b9da19ed0d 100644 --- a/include/openspace/util/time.h +++ b/include/openspace/util/time.h @@ -81,7 +81,7 @@ public: /** * Sets the current time to the specified value in seconds past the J2000 epoch. This * value can be negative to represent dates before the epoch. - * \param The number of seconds after the J2000 epoch + * \param value The number of seconds after the J2000 epoch */ void setTime(double value);