[mlpack-git] master: Add header comments, fix header guard naming to be in line with the rest of the files. (1810717)

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

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

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/904762495c039e345beba14c1142fd719b3bd50e...f94823c800ad6f7266995c700b1b630d5ffdcf40

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

commit 1810717cf848b5a6d9b9b8718523771dd00a96fc
Author: Ryan Curtin <ryan at ratml.org>
Date:   Thu Aug 7 15:10:20 2014 +0000

    Add header comments, fix header guard naming to be in line with the rest of the
    files.


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

1810717cf848b5a6d9b9b8718523771dd00a96fc
 src/mlpack/methods/adaboost/adaboost.hpp      | 23 +++++++++++++++++++----
 src/mlpack/methods/adaboost/adaboost_impl.hpp |  5 ++---
 2 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/src/mlpack/methods/adaboost/adaboost.hpp b/src/mlpack/methods/adaboost/adaboost.hpp
index b1b64aa..838a61c 100644
--- a/src/mlpack/methods/adaboost/adaboost.hpp
+++ b/src/mlpack/methods/adaboost/adaboost.hpp
@@ -2,11 +2,26 @@
  * @file adaboost.hpp
  * @author Udit Saxena
  *
- * AdaBoost header file
+ * The AdaBoost class.  AdaBoost is a boosting algorithm, meaning that it
+ * combines an ensemble of weak learners to produce a strong learner.  For more
+ * information on AdaBoost, see the following paper:
+ *
+ * @code
+ * @article{schapire1999improved,
+ *   author = {Schapire, Robert E. and Singer, Yoram},
+ *   title = {Improved Boosting Algorithms Using Confidence-rated Predictions},
+ *   journal = {Machine Learning},
+ *   volume = {37},
+ *   number = {3},
+ *   month = dec,
+ *   year = {1999},
+ *   issn = {0885-6125},
+ *   pages = {297--336},
+ * }
+ * @endcode
  */
-
-#ifndef _MLPACK_METHODS_ADABOOST_ADABOOST_HPP
-#define _MLPACK_METHODS_ADABOOST_ADABOOST_HPP
+#ifndef __MLPACK_METHODS_ADABOOST_ADABOOST_HPP
+#define __MLPACK_METHODS_ADABOOST_ADABOOST_HPP
 
 #include <mlpack/core.hpp>
 #include <mlpack/methods/perceptron/perceptron.hpp>
diff --git a/src/mlpack/methods/adaboost/adaboost_impl.hpp b/src/mlpack/methods/adaboost/adaboost_impl.hpp
index 4a9d3c0..8c51441 100644
--- a/src/mlpack/methods/adaboost/adaboost_impl.hpp
+++ b/src/mlpack/methods/adaboost/adaboost_impl.hpp
@@ -18,9 +18,8 @@
  * }
  * @endcode
  */
-
-#ifndef _MLPACK_METHODS_ADABOOST_ADABOOST_IMPL_HPP
-#define _MLPACK_METHODS_ADABOOST_ADABOOST_IMPL_HPP
+#ifndef __MLPACK_METHODS_ADABOOST_ADABOOST_IMPL_HPP
+#define __MLPACK_METHODS_ADABOOST_ADABOOST_IMPL_HPP
 
 #include "adaboost.hpp"