Fix references to plural names in API documentation
authorChristos Nikolaou <christnn@auth.gr>
Wed, 5 Nov 2014 16:09:47 +0000 (18:09 +0200)
committerEvan Shelhamer <shelhamer@imaginarynumber.net>
Sat, 7 Mar 2015 07:15:31 +0000 (23:15 -0800)
Changed each "&" character that conected the class name and the "s"
character to "%", so that it is properly displayed.

include/caffe/blob.hpp
include/caffe/layer.hpp

index 36579a5..472cc18 100644 (file)
@@ -246,7 +246,7 @@ class Blob {
 
   /**
    * @brief Set the data_ shared_ptr to point to the SyncedMemory holding the
-   *        data_ of Blob other -- useful in Layer&s which simply perform a copy
+   *        data_ of Blob other -- useful in Layer%s which simply perform a copy
    *        in their Forward pass.
    *
    * This deallocates the SyncedMemory holding this Blob's data_, as
@@ -255,7 +255,7 @@ class Blob {
   void ShareData(const Blob& other);
   /**
    * @brief Set the diff_ shared_ptr to point to the SyncedMemory holding the
-   *        diff_ of Blob other -- useful in Layer&s which simply perform a copy
+   *        diff_ of Blob other -- useful in Layer%s which simply perform a copy
    *        in their Forward pass.
    *
    * This deallocates the SyncedMemory holding this Blob's diff_, as
index 34e00d7..2d13ef9 100644 (file)
@@ -17,11 +17,11 @@ namespace caffe {
  * @brief An interface for the units of computation which can be composed into a
  *        Net.
  *
- * Layer&s must implement a Forward function, in which they take their input
- * (bottom) Blob&s (if any) and compute their output Blob&s (if any).
+ * Layer%s must implement a Forward function, in which they take their input
+ * (bottom) Blob%s (if any) and compute their output Blob%s (if any).
  * They may also implement a Backward function, in which they compute the error
- * gradients with respect to their input Blob&s, given the error gradients with
- * their output Blob&s.
+ * gradients with respect to their input Blob%s, given the error gradients with
+ * their output Blob%s.
  */
 template <typename Dtype>
 class Layer {