Update file docstrings for cpp files and Classes

src/classification/ConvexHull1D.cpp

@@ -11,6 +11,14 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+/** @file classification/ConvexHull1D.cpp
+ *  @brief Implements a class that calculates the 1D Convex Hull overlap of a vector with property labels
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "classification/ConvexHull1D.hpp"
 
 ConvexHull1D::ConvexHull1D() :

src/classification/ConvexHull1D.hpp

@@ -27,6 +27,10 @@
 #include "classification/prop_sorted_d_mat.hpp"
 #include "utils/math_funcs.hpp"
 
+// DocString: cls_convex_hull_1d
+/**
+ * @brief Calculates the 1D convex hull overlap between a vector with property labels
+ */
 class ConvexHull1D
 {
 protected :

src/classification/LPWrapper.cpp

@@ -11,6 +11,14 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+/** @file classification/LPWrapper.cpp
+ *  @brief Implements a class used to wrap the Coin-Clp Simplex Library, and facilitate its use with SISSO++
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "classification/LPWrapper.hpp"
 #include <iomanip>
 LPWrapper::LPWrapper(

src/classification/LPWrapper.hpp

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 /** @file classification/LPWrapper.hpp
- *  @brief A class used to wrap the Coin-Clp Simplex Library, and facilitate its use with SISSO++
+ *  @brief Defines a class used to wrap the Coin-Clp Simplex Library, and facilitate its use with SISSO++
  *
  *  @author Thomas A. R. Purcell (tpurcell90)
  *  @bug No known bugs.
@@ -28,6 +28,11 @@
 
 #include "classification/prop_sorted_d_mat.hpp"
 #include "utils/mkl_interface.hpp"
+
+// DocString: cls_lp_wrapper
+/**
+ * @brief A wrapper to the ClpSimplex library to facilitate use with SISSO++
+ */
 class LPWrapper
 {
 protected:

src/classification/SVMWrapper.cpp

@@ -12,6 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+/** @file classification/SVMWrapper.cpp
+ *  @brief Implements a class used to wrap libsvm in more C++ oriented data structure
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "classification/SVMWrapper.hpp"
 
 SVMWrapper::SVMWrapper(const int n_class, const int n_dim, const int n_samp, const double* prop) :

src/classification/SVMWrapper.hpp

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 /** @file classification/SVMWrapper.hpp
- *  @brief A class used to wrap libsvm in more C++ oriented data structure
+ *  @brief Defines a class used to wrap libsvm in more C++ oriented data structure
  *
  *  @author Thomas A. R. Purcell (tpurcell90)
  *  @bug No known bugs.
@@ -28,6 +28,11 @@
 #include "classification/prop_sorted_d_mat.hpp"
 #include "external/libsvm/svm.h"
 
+// DocString: cls_svm_wrapper
+/**
+ * @brief Wrapper for libSVM that uses more C++ friendly data structures
+ *
+ */
 class SVMWrapper
 {
 protected:

src/classification/prop_sorted_d_mat.cpp

@@ -11,6 +11,14 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+/** @file classification/prop_sorted_d_mat.cpp
+ *  @brief Implements the functions for the central storage area for a sorted descriptor matrix based on the task/class of a sample
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "classification/prop_sorted_d_mat.hpp"
 
 std::vector<double> prop_sorted_d_mat::SORTED_D_MATRIX;

src/descriptor_identifier/model/Model.cpp

@@ -11,6 +11,14 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+/** @file descriptor_identifier/model/Model.cpp
+ *  @brief Implements the base class of the output Models for SISSO
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "descriptor_identifier/model/Model.hpp"
 
 Model::Model(

src/descriptor_identifier/model/Model.hpp

@@ -36,7 +36,7 @@
 
 // DocString: cls_model
 /**
- * @brief Class to store the models found from SISSO
+ * @brief Base class to store the output models from SISSO
  *
  */
 class Model

src/descriptor_identifier/model/ModelClassifier.cpp

@@ -11,6 +11,14 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+/** @file descriptor_identifier/model/ModelClassifier.cpp
+ *  @brief Implements a class for the output models from solving a classification problem
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "descriptor_identifier/model/ModelClassifier.hpp"
 
 ModelClassifier::ModelClassifier(

src/descriptor_identifier/model/ModelClassifier.hpp

@@ -31,7 +31,7 @@
 
 // DocString: cls_model_class
 /**
- * @brief Class to store the models found from SISSO
+ * @brief Class to store the output models from SISSOClassifier
  *
  */
 class ModelClassifier : public Model

src/descriptor_identifier/model/ModelLogRegressor.cpp

@@ -11,6 +11,14 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+/** @file descriptor_identifier/model/ModelLogRegressor.cpp
+ *  @brief Implements a class for the output models from solving a log regression problem
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "descriptor_identifier/model/ModelLogRegressor.hpp"
 
 ModelLogRegressor::ModelLogRegressor()

src/descriptor_identifier/model/ModelLogRegressor.hpp

@@ -29,9 +29,9 @@
     namespace py = boost::python;
 #endif
 
-// DocString: cls_model_reg
+// DocString: cls_model_log_reg
 /**
- * @brief Class to store the models found from SISSO
+ * @brief Class to store the output models from SISSOLogRegressor
  *
  */
 class ModelLogRegressor : public ModelRegressor

src/descriptor_identifier/model/ModelRegressor.cpp

@@ -11,6 +11,14 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+/** @file descriptor_identifier/model/ModelRegressor.cpp
+ *  @brief Implements a class for the output models from solving a regression problem
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "descriptor_identifier/model/ModelRegressor.hpp"
 
 ModelRegressor::ModelRegressor()

src/descriptor_identifier/model/ModelRegressor.hpp

@@ -31,7 +31,7 @@
 
 // DocString: cls_model_reg
 /**
- * @brief Class to store the models found from SISSO
+ * @brief Class to store the output models from SISSORegressor
  *
  */
 class ModelRegressor : public Model

src/descriptor_identifier/solver/SISSOClassifier.cpp

@@ -11,6 +11,14 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+/** @file descriptor_identifier/SISSOClassifier.cpp
+ *  @brief Implements a class for solving classification problems with SISSO
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "descriptor_identifier/solver/SISSOClassifier.hpp"
 
 SISSOClassifier::SISSOClassifier(

src/descriptor_identifier/solver/SISSOClassifier.hpp

@@ -35,7 +35,7 @@
 
 // DocString: cls_sisso_class
 /**
- * @brief SISSO Classifier class, performs the SISSO algorithm and stores all selected models
+ * @brief Uses SISSO to solve a classification problem
  *
  */
 class SISSOClassifier: public SISSOSolver

src/descriptor_identifier/solver/SISSOLogRegressor.cpp

@@ -11,6 +11,14 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+/** @file descriptor_identifier/SISSOLogRegressor.cpp
+ *  @brief Implements a class for solving logarithmic regression problems with SISSO
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "descriptor_identifier/solver/SISSOLogRegressor.hpp"
 
 SISSOLogRegressor::SISSOLogRegressor(

src/descriptor_identifier/solver/SISSOLogRegressor.hpp

@@ -32,7 +32,7 @@
 
 // DocString: cls_sisso_log_reg
 /**
- * @brief SISSO Regressor class, performs the SISSO algorithm and stores all selected models
+ * @brief Uses SISSO to solve a log regression problem
  *
  */
 class SISSOLogRegressor: public SISSORegressor

src/descriptor_identifier/solver/SISSORegressor.cpp

@@ -11,6 +11,14 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
+/** @file descriptor_identifier/SISSORegressor.cpp
+ *  @brief Implements a class to solve regression problems with SISSO
+ *
+ *  @author Thomas A. R. Purcell (tpurcell90)
+ *  @bug No known bugs.
+ */
+
 #include "descriptor_identifier/solver/SISSORegressor.hpp"
 
 SISSORegressor::SISSORegressor(