[mlpack-git] master: Slightly better documentation. (29160cf)

[gitdub at big.cc.gt.atl.ga.us]

Repository : https://github.com/mlpack/mlpack

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/de9cc4b05069e1fa4793d9355f2f595af5ff45d2...6070527af14296cd99739de6c62666cc5d2a2125

>---------------------------------------------------------------

commit 29160cf528e34e76ce6cdc6e3bfd35c8ff6355b8
Author: Ryan Curtin <ryan at ratml.org>
Date:   Sun Nov 1 16:58:59 2015 +0000

    Slightly better documentation.


>---------------------------------------------------------------

29160cf528e34e76ce6cdc6e3bfd35c8ff6355b8
 src/mlpack/core/data/dataset_info.hpp      | 5 +++++
 src/mlpack/core/data/dataset_info_impl.hpp | 1 +
 2 files changed, 6 insertions(+)

diff --git a/src/mlpack/core/data/dataset_info.hpp b/src/mlpack/core/data/dataset_info.hpp
index 0387877..5ad688d 100644
--- a/src/mlpack/core/data/dataset_info.hpp
+++ b/src/mlpack/core/data/dataset_info.hpp
@@ -38,6 +38,11 @@ enum Datatype : bool /* bool is all the precision we need for two types */
 class DatasetInfo
 {
  public:
+  /**
+   * Create the DatasetInfo object with the given dimensionality.  Note that the
+   * dimensionality cannot be changed later; you will have to create a new
+   * DatasetInfo object.
+   */
   DatasetInfo(const size_t dimensionality = 0);
 
   /**
diff --git a/src/mlpack/core/data/dataset_info_impl.hpp b/src/mlpack/core/data/dataset_info_impl.hpp
index ebd2dc1..4c6002f 100644
--- a/src/mlpack/core/data/dataset_info_impl.hpp
+++ b/src/mlpack/core/data/dataset_info_impl.hpp
@@ -13,6 +13,7 @@
 namespace mlpack {
 namespace data {
 
+// Default constructor.
 inline DatasetInfo::DatasetInfo(const size_t dimensionality) :
     types(dimensionality, Datatype::numeric)
 {