Doxygen style overhaul (#2954)

Reformatting the existing Doxygen comments to be unified

modules/base/rendering/renderablenodearrow.h

@@ -42,8 +42,7 @@ namespace documentation { struct Documentation; }
 class Translation;
 
 /**
- * Generates an arrow shape that points from the start node to the
- * end node
+ * Generates an arrow shape that points from the start node to the end node.
  */
 class RenderableNodeArrow : public Renderable {
 public:

modules/base/rendering/renderabletrail.h

@@ -72,10 +72,9 @@ class Translation;
  */
 class RenderableTrail : public Renderable {
 public:
+    const double DISTANCE_CULLING_RADII = 800.0;
 
-const double DISTANCE_CULLING_RADII = 800.0;
-
-struct Appearance : properties::PropertyOwner {
+    struct Appearance : properties::PropertyOwner {
         Appearance();
         /// Specifies the base color of the line before fading
         properties::Vec3Property lineColor;
@@ -111,10 +110,11 @@ struct Appearance : properties::PropertyOwner {
 protected:
     explicit RenderableTrail(const ghoul::Dictionary& dictionary);
 
-    /// Returns the documentation entries that the con
     static documentation::Documentation Documentation();
 
-    /// The layout of the VBOs
+    /**
+     * The layout of the VBOs.
+     */
     struct TrailVBOLayout {
         float x, y, z;
     };
@@ -130,13 +130,18 @@ protected:
     /// The Translation object that provides the position of the individual trail points
     ghoul::mm_unique_ptr<Translation> _translation;
 
-    /// The RenderInformation contains information filled in by the concrete subclasses to
-    /// be used by this class.
+    /**
+     * The RenderInformation contains information filled in by the concrete subclasses to
+     * be used by this class.
+     */
     struct RenderInformation {
         enum class VertexSorting {
-            NewestFirst = 0,    ///< Newer vertices have a lower index than older ones
-            OldestFirst,        ///< Older vertices have a lower index than newer ones
-            NoSorting           ///< No ordering in the vertices; no fading applied
+            /// Newer vertices have a lower index than older ones
+            NewestFirst = 0,
+            /// Older vertices have a lower index than newer ones
+            OldestFirst,
+            /// No ordering in the vertices; no fading applied
+            NoSorting
         };
         /// The first element in the vertex buffer to be rendered
         GLint first = 0;

modules/base/rendering/renderabletrailorbit.h

@@ -58,14 +58,18 @@ public:
 private:
     /**
      * Performs a full sweep of the orbit and fills the entire vertex buffer object.
+     *
      * \param time The current time up to which the full sweep should be performed
      */
     void fullSweep(double time);
 
-    /// This structure is returned from the #updateTrails method and gives information
-    /// about which parts of the vertex array to update
+    /**
+     * This structure is returned from the #updateTrails method and gives information
+     * about which parts of the vertex array to update.
+     */
     struct UpdateReport {
-        static constexpr int All = 0; ///< The entire array was touched in the update
+        /// The entire array was touched in the update
+        static constexpr int All = 0;
 
         /// If `true` the floating point needs to be updated
         bool floatingPointNeedsUpdate;
@@ -73,8 +77,8 @@ private:
         /// If `true` at least one of their permanent point were touched
         bool permanentPointsNeedUpdate;
 
-        /// Returns the number of fixed points that were touched in the update method
-        /// If this value is negative, the newest values were replaced, if positive the
+        /// Returns the number of fixed points that were touched in the update method. If
+        /// this value is negative, the newest values were replaced, if positive the
         /// oldest
         int nUpdated;
     };
@@ -82,6 +86,7 @@ private:
      * Updates the trail based on the new incoming UpdateData information. This function
      * might update an arbitrary number of values in the vertex buffer and returns an
      * UpdateReport that will tell the #update method how many values were modified.
+     *
      * \param data The UpdateData struct that comes from the #update method
      * \return The UpdateReport containing information which array parts were touched
      */

modules/base/rendering/renderabletrailtrajectory.h

@@ -61,7 +61,9 @@ public:
 
 private:
 
-    /// Reset some variables to default state
+    /**
+     * Reset some variables to default state.
+     */
     void reset();
 
     /// The number of vertices that we calculate during each frame of the full sweep pass

modules/base/rendering/screenspacedashboard.h

@@ -61,10 +61,6 @@ public:
 private:
     Dashboard _dashboard;
     properties::BoolProperty _useMainDashboard;
-    //std::unique_ptr<ghoul::fontrendering::FontRenderer> _fontRenderer;
-
-    //std::shared_ptr<ghoul::fontrendering::Font> _fontDate;
-    //std::shared_ptr<ghoul::fontrendering::Font> _fontInfo;
 };
 
 } // namespace openspace

modules/base/rendering/screenspaceframebuffer.h

@@ -39,12 +39,10 @@ namespace openspace {
 namespace documentation { struct Documentation; }
 
 /**
- * @brief Creates a texture by rendering to a framebuffer, this is then used on a screen
- *        space plane.
- * @details This class lets you ass renderfunctions that should render to a framebuffer
- *          with an attached texture.
- * The texture is then used on a screen space plane that works both in fisheye and flat
- * screens.
+ * Creates a texture by rendering to a framebuffer, this is then used on a screen space
+ * plane. This class lets you ass renderfunctions that should render to a framebuffer with
+ * an attached texture. The texture is then used on a screen space plane that works both
+ * in fisheye and flat screens.
  */
 class ScreenSpaceFramebuffer : public ScreenSpaceRenderable {
 public: