data_layers: Doxygen \brief & TODO stubs.

1 files changed, 39 insertions, 4 deletions

diff --git a/include/caffe/data_layers.hpp b/include/caffe/data_layers.hpp
index f972965b..bebbab10 100644
--- a/include/caffe/data_layers.hpp
+++ b/include/caffe/data_layers.hpp
@@ -23,8 +23,14 @@ namespace caffe {
 #define HDF5_DATA_DATASET_NAME "data"
 #define HDF5_DATA_LABEL_NAME "label"
 
-// TODO: DataLayer, ImageDataLayer, and WindowDataLayer all have the
-// same basic structure and a lot of duplicated code.
+/**
+ * @brief Provides data to the Net from a LevelDB or LMDB.
+ *
+ * TODO: DataLayer, ImageDataLayer, and WindowDataLayer all have the
+ * same basic structure and a lot of duplicated code.
+ *
+ * TODO(dox): thorough documentation for Forward and proto params.
+ */
 template <typename Dtype>
 class DataLayer : public Layer<Dtype>, public InternalThread {
  public:
@@ -80,6 +86,11 @@ class DataLayer : public Layer<Dtype>, public InternalThread {
   Caffe::Phase phase_;
 };
 
+/**
+ * @brief Provides data to the Net generated by a Filler.
+ *
+ * TODO(dox): thorough documentation for Forward and proto params.
+ */
 template <typename Dtype>
 class DummyDataLayer : public Layer<Dtype> {
  public:
@@ -106,6 +117,11 @@ class DummyDataLayer : public Layer<Dtype> {
   vector<bool> refill_;
 };
 
+/**
+ * @brief Provides data to the Net from HDF5 files.
+ *
+ * TODO(dox): thorough documentation for Forward and proto params.
+ */
 template <typename Dtype>
 class HDF5DataLayer : public Layer<Dtype> {
  public:
@@ -140,6 +156,11 @@ class HDF5DataLayer : public Layer<Dtype> {
   Blob<Dtype> label_blob_;
 };
 
+/**
+ * @brief Write blobs to disk as HDF5 files.
+ *
+ * TODO(dox): thorough documentation for Forward and proto params.
+ */
 template <typename Dtype>
 class HDF5OutputLayer : public Layer<Dtype> {
  public:
@@ -174,6 +195,11 @@ class HDF5OutputLayer : public Layer<Dtype> {
   Blob<Dtype> label_blob_;
 };
 
+/**
+ * @brief Provides data to the Net from image files.
+ *
+ * TODO(dox): thorough documentation for Forward and proto params.
+ */
 template <typename Dtype>
 class ImageDataLayer : public Layer<Dtype>, public InternalThread {
  public:
@@ -221,8 +247,11 @@ class ImageDataLayer : public Layer<Dtype>, public InternalThread {
   Caffe::Phase phase_;
 };
 
-/* MemoryDataLayer
-*/
+/**
+ * @brief Provides data to the Net from memory.
+ *
+ * TODO(dox): thorough documentation for Forward and proto params.
+ */
 template <typename Dtype>
 class MemoryDataLayer : public Layer<Dtype> {
  public:
@@ -264,6 +293,12 @@ class MemoryDataLayer : public Layer<Dtype> {
   int pos_;
 };
 
+/**
+ * @brief Provides data to the Net from windows of images files, specified
+ *        by a window data file.
+ *
+ * TODO(dox): thorough documentation for Forward and proto params.
+ */
 template <typename Dtype>
 class WindowDataLayer : public Layer<Dtype>, public InternalThread {
  public: