change doxygen syntax to match axom's standard

src/axom/sina/core/AdiakWriter.cpp

@@ -3,8 +3,15 @@
 //
 // SPDX-License-Identifier: (BSD-3-Clause)
 
-
-/// @file
+/*!
+ ******************************************************************************
+ *
+ * \file AdiakWriter.cpp
+ *
+ * \brief   Implementation file for the Adiak Sina callback function.
+ *
+ ******************************************************************************
+ */
 
 #include "axom/sina/core/AdiakWriter.hpp"
 

src/axom/sina/core/AdiakWriter.hpp

@@ -7,7 +7,15 @@
 #ifndef SINA_ADIAK_HPP
 #define SINA_ADIAK_HPP
 
-/// @file
+/*!
+ ******************************************************************************
+ *
+ * \file AdiakWriter.hpp
+ *
+ * \brief   Implementation file for the Adiak Sina callback function.
+ *
+ ******************************************************************************
+ */
 
 #include "axom/config.hpp"
 #ifdef AXOM_USE_ADIAK
@@ -29,7 +37,7 @@ namespace sina
 {
 
 /**
- * The callback function to pass to Adiak in order to write collected data to a Sina Record.
+ * \brief The callback function to pass to Adiak in order to write collected data to a Sina Record.
  *
  * To register this with Adiak, you should call adiak_register_cb, passing in
  * a pointer to the record as the last value. Your code should look something
@@ -40,10 +48,10 @@ namespace sina
  *     axom::sina::adiak_register_cb(1, adiak_category_all, axom::sina::adiakSinaCallback, 0, &record);
  * \endcode
  *
- * Note that not everything that Sina can capture an be captured through the
- * Adiak API. For example, there is currently no support in Adiak to capture
- * anything like a CurveSet. As a result, to do that, you must hold on to
- * the Record object passed here as the opaque value and manipulate it directly.
+ * \attention Not everything that Sina can capture an be captured through the
+ *            Adiak API. For example, there is currently no support in Adiak to capture
+ *            anything like a CurveSet. As a result, to do that, you must hold on to
+ *            the Record object passed here as the opaque value and manipulate it directly.
  **/
 void adiakSinaCallback(const char *name, adiak_category_t category, const char *subcategory, adiak_value_t *value, adiak_datatype_t *t, void *opaque_value);
 

src/axom/sina/core/ConduitUtil.cpp

@@ -4,6 +4,16 @@
 // SPDX-License-Identifier: (BSD-3-Clause)
 
 
+/*!
+ ******************************************************************************
+ *
+ * \file ConduitUtil.cpp
+ *
+ * \brief   Implementation file for Sina Conduit utility functions
+ *
+ ******************************************************************************
+ */
+
 #include "axom/sina/core/ConduitUtil.hpp"
 
 #include <iostream>

src/axom/sina/core/ConduitUtil.hpp

@@ -7,6 +7,16 @@
 #ifndef SINA_JSONUTIL_HPP
 #define SINA_JSONUTIL_HPP
 
+/*!
+ ******************************************************************************
+ *
+ * \file ConduitUtil.hpp
+ *
+ * \brief   Implementation file for Sina Conduit utility functions
+ *
+ ******************************************************************************
+ */
+
 #include <string>
 #include <vector>
 
@@ -18,90 +28,90 @@ namespace sina
 {
 
 /**
- * Get a required field from a conduit Node.
+ * \brief Get a required field from a conduit Node.
  *
- * @param fieldName the name of the field to get
- * @param parent the parent object from which to get the field
- * @param parentType a user-friendly name of the type of the parent to use
- * in an error message if the field doesn't exist.
- * @return the requested field as a Node
- * @throws std::invalid_argument if the field does not exist
+ * \param fieldName the name of the field to get
+ * \param parent the parent object from which to get the field
+ * \param parentType a user-friendly name of the type of the parent to use
+ *                   in an error message if the field doesn't exist.
+ * \return the requested field as a Node
+ * \throws std::invalid_argument if the field does not exist
  */
 conduit::Node const &getRequiredField(std::string const &fieldName,
         conduit::Node const &parent, std::string const &parentType);
 
 /**
- * Get the value of a required field from a conduit Node. The field value
- * must be a string.
+ * \brief Get the value of a required field from a conduit Node. The field value
+ *        must be a string.
  *
- * @param fieldName the name of the field to get
- * @param parent the parent object from which to get the field
- * @param parentType a user-friendly name of the type of the parent to use
- * in an error message if the field doesn't exist.
- * @return the value of the requested field
- * @throws std::invalid_argument if the field does not exist or is not a string
+ * \param fieldName the name of the field to get
+ * \param parent the parent object from which to get the field
+ * \param parentType a user-friendly name of the type of the parent to use
+ *                   in an error message if the field doesn't exist.
+ * \return the value of the requested field
+ * \throws std::invalid_argument if the field does not exist or is not a string
  */
 std::string getRequiredString(std::string const &fieldName,
         conduit::Node const &parent, std::string const &parentType);
 
 /**
- * Get the value of a required field from a conduit Node. The field value
- * must be a double.
+ * \brief Get the value of a required field from a conduit Node. The field value
+ *        must be a double.
  *
- * @param fieldName the name of the field to get
- * @param parent the parent object from which to get the field
- * @param parentType a user-friendly name of the type of the parent to use
- * in an error message if the field doesn't exist.
- * @return the value of the requested field
- * @throws std::invalid_argument if the field does not exist or is not a double
+ * \param fieldName the name of the field to get
+ * \param parent the parent object from which to get the field
+ * \param parentType a user-friendly name of the type of the parent to use
+ *                   in an error message if the field doesn't exist.
+ * \return the value of the requested field
+ * \throws std::invalid_argument if the field does not exist or is not a double
  */
 double getRequiredDouble(std::string const &fieldName,
         conduit::Node const &parent, std::string const &parentType);
 
 /**
- * Get the value of an optional field from a conduit Node. The field value
- * must be a string if it is present.
+ * \brief Get the value of an optional field from a conduit Node. The field value
+ *        must be a string if it is present.
  *
- * @param fieldName the name of the field to get
- * @param parent the parent object from which to get the field
- * @param parentType a user-friendly name of the type of the parent to use
- * in an error message if the field doesn't exist.
- * @return the value of the requested field, or an empty string if it
- * does not exist
- * @throws std::invalid_argument if the field exists but is not a string
+ * \param fieldName the name of the field to get
+ * \param parent the parent object from which to get the field
+ * \param parentType a user-friendly name of the type of the parent to use
+ *                   in an error message if the field doesn't exist.
+ * \return the value of the requested field, or an empty string if it
+ *         does not exist
+ * \throws std::invalid_argument if the field exists but is not a string
  */
 std::string getOptionalString(std::string const &fieldName,
         conduit::Node const &parent, std::string const &parentType);
 
 /**
- * Convert the given node to a vector of doubles.
+ * \brief Convert the given node to a vector of doubles.
  *
- * @param node the node to convert
- * @param name the name of the node, used in error reporting
- * @return the node as a list of doubles
- * @throws std::invalid_argument if the node is not a list of doubles
+ * \param node the node to convert
+ * \param name the name of the node, used in error reporting
+ * \return the node as a list of doubles
+ * \throws std::invalid_argument if the node is not a list of doubles
  */
 std::vector<double> toDoubleVector(conduit::Node const &node,
         std::string const &name);
 
 /**
- * Convert the given node to a vector of strings.
+ * \brief Convert the given node to a vector of strings.
  *
- * @param node the node to convert
- * @param name the name of the node, used in error reporting
- * @return the node as a list of strings
- * @throws std::invalid_argument if the node is not a list of strings
+ * \param node the node to convert
+ * \param name the name of the node, used in error reporting
+ * \return the node as a list of strings
+ * \throws std::invalid_argument if the node is not a list of strings
  */
 std::vector<std::string> toStringVector(conduit::Node const &node,
         std::string const &name);
 
 /**
- * Add a vector of strings to a Node. This operation's not natively
- * part of Conduit.
+ * \brief Add a vector of strings to a Node. This operation's not natively
+ *        part of Conduit.
  *
- * @param parent the node to add the strings to
- * @param child_name the name of the child (aka the name of the field)
- * @param string_values the data values for the field
+ * \param parent the node to add the strings to
+ * \param child_name the name of the child (aka the name of the field)
+ * \param string_values the data values for the field
  */
 void addStringsToNode(conduit::Node &parent, const std::string &child_name,
       std::vector<std::string> const &string_values);

src/axom/sina/core/Curve.cpp

@@ -3,6 +3,15 @@
 //
 // SPDX-License-Identifier: (BSD-3-Clause)
 
+/*!
+ ******************************************************************************
+ *
+ * \file Curve.cpp
+ *
+ * \brief   Implementation file for Sina Curve class
+ *
+ ******************************************************************************
+ */
 
 #include "axom/sina/core/Curve.hpp"
 #include "axom/sina/core/ConduitUtil.hpp"

src/axom/sina/core/Curve.hpp

@@ -7,10 +7,14 @@
 #ifndef SINA_CURVE_HPP
 #define SINA_CURVE_HPP
 
-/**
- * @file
+/*!
+ ******************************************************************************
+ *
+ * \file Curve.hpp
+ *
+ * \brief   Implementation file for Sina Curve class
  *
- * Contains the definition of the Curve class. 
+ ******************************************************************************
  */
 
 #include <string>
@@ -29,84 +33,84 @@ namespace sina
 class Curve {
 public:
     /**
-     * Create a Curve with the given name and values
+     * \brief Create a Curve with the given name and values
      *
-     * @param name the name of the curve
-     * @param values the curve's values
+     * \param name the name of the curve
+     * \param values the curve's values
      */
     Curve(std::string name, std::vector<double> values);
 
     /**
-     * Create a Curve with the given name and values
+     * \brief Create a Curve with the given name and values
      *
-     * @param name the name of the curve
-     * @param values the curve's values
-     * @param numValues the number of values.
+     * \param name the name of the curve
+     * \param values the curve's values
+     * \param numValues the number of values.
      */
     Curve(std::string name, double const *values, std::size_t numValues);
 
     /**
-     * Create a Curve by deserializing a conduit node.
+     * \brief Create a Curve by deserializing a conduit node.
      *
-     * @param name the name of the curve
-     * @param curveAsNode the serialized version of a curve
+     * \param name the name of the curve
+     * \param curveAsNode the serialized version of a curve
      */
     Curve(std::string name, conduit::Node const &curveAsNode);
 
     /**
-     * Get the curve's name.
+     * \brief Get the curve's name.
      *
-     * @return the curve's name
+     * \return the curve's name
      */
     std::string const &getName() const {
         return name;
     }
 
     /**
-     * Get the values of the curve.
+     * \brief Get the values of the curve.
      *
-     * @return the curve's values
+     * \return the curve's values
      */
     std::vector<double> const &getValues() const {
         return values;
     }
 
     /**
-     * Set the units of the values.
+     * \brief Set the units of the values.
      *
-     * @param units the value's units
+     * \param units the value's units
      */
     void setUnits(std::string units);
 
     /**
-     * Get the units of the values.
+     * \brief Get the units of the values.
      *
-     * @return the value's units
+     * \return the value's units
      */
     std::string const &getUnits() const {
         return units;
     }
 
     /**
-     * Set the tags for this curve.
+     * \brief Set the tags for this curve.
      *
-     * @param tags the curve's tags
+     * \param tags the curve's tags
      */
     void setTags(std::vector<std::string> tags);
 
     /**
-     * Get the tags for this curve.
+     * \brief Get the tags for this curve.
      *
-     * @return the curve's tags
+     * \return the curve's tags
      */
     std::vector<std::string> const &getTags() const {
         return tags;
     }
 
     /**
-     * Convert this curve to a Conduit node.
+     * \brief Convert this curve to a Conduit node.
      *
-     * @return a Conduit representation of this curve
+     * \return a Conduit representation of this curve
      */
     conduit::Node toNode() const;
 

src/axom/sina/core/CurveSet.cpp

@@ -3,6 +3,17 @@
 //
 // SPDX-License-Identifier: (BSD-3-Clause)
 
+/*!
+ ******************************************************************************
+ *
+ * \file CurveSet.cpp
+ *
+ * \brief   Implementation file for Sina CurveSet class
+ *
+ * \sa Curve.hpp
+ *
+ ******************************************************************************
+ */
 
 #include "axom/sina/core/CurveSet.hpp"