[PPL-devel] [GIT] ppl/ppl(master): Improved (devref) documentation for Matrix::add_( recycled_)row methods.

[Enea Zaffanella]

Module: ppl/ppl
Branch: master
Commit: 05cdf3ade39391ba25dc992cabe93a7758e23dac
URL:    http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=05cdf3ade39391ba25dc992cabe93a7758e23dac

Author: Enea Zaffanella <zaffanella at cs.unipr.it>
Date:   Mon Feb 15 11:18:23 2010 +0100

Improved (devref) documentation for Matrix::add_(recycled_)row methods.

---

 src/Matrix.defs.hh |    9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/src/Matrix.defs.hh b/src/Matrix.defs.hh
index f521467..e0112b6 100644
--- a/src/Matrix.defs.hh
+++ b/src/Matrix.defs.hh
@@ -227,7 +227,7 @@ public:
 
     Turns the \f$r \times c\f$ matrix \f$M\f$ into
     the \f$(r+1) \times c\f$ matrix
-    \f$\genfrac{(}{)}{0pt}{}{M}{0}\f$.
+    \f$\genfrac{(}{)}{0pt}{}{M}{y}\f$.
     The matrix is expanded avoiding reallocation whenever possible.
   */
   void add_row(const Row& y);
@@ -235,12 +235,13 @@ public:
   //! Adds the row \p y to the matrix.
   /*!
     \param y
-    The row to be added: it must have the same size and capacity as \p
-    *this.
+    The row to be added: it must have the same size and capacity as
+    \p *this. It is not declared <CODE>const</CODE> because its
+    data-structures will recycled to build the new matrix row.
 
     Turns the \f$r \times c\f$ matrix \f$M\f$ into
     the \f$(r+1) \times c\f$ matrix
-    \f$\genfrac{(}{)}{0pt}{}{M}{0}\f$.
+    \f$\genfrac{(}{)}{0pt}{}{M}{y}\f$.
     The matrix is expanded avoiding reallocation whenever possible.
   */
   void add_recycled_row(Row& y);