fixed some documentation inconsistencies

diff --git a/ginac/archive.h b/ginac/archive.h
index 1bfa2a2ca2df0c3c8ea1ecc08ed884de89ad68c6..10996ad7c7582b1761982c057428d0faa10922b4 100644 (file)
--- a/ginac/archive.h
+++ b/ginac/archive.h
@@ -174,17 +174,20 @@ public:
        void archive_ex(const ex &e, const char *name);
 
        /** Retrieve expression from archive by name.
-        *  @param sym_lst list of pre-defined symbols */
+        *  @param sym_lst list of pre-defined symbols
+        *  @param name name of expression */
        ex unarchive_ex(const lst &sym_lst, const char *name) const;
 
        /** Retrieve expression from archive by index.
         *  @param sym_lst list of pre-defined symbols
+        *  @param index index of expression
      *  @see count_expressions */
        ex unarchive_ex(const lst &sym_lst, unsigned index = 0) const;
 
        /** Retrieve expression and its name from archive by index.
         *  @param sym_lst list of pre-defined symbols
         *  @param name receives the name of the expression
+        *  @param index index of expression
      *  @see count_expressions */
        ex unarchive_ex(const lst &sym_lst, std::string &name, unsigned index = 0) const;
 

diff --git a/ginac/clifford.h b/ginac/clifford.h
index e63ed5471a4be5cee5bff4a935bf687ba6d72380..00a12a579a07375907a5de88aec9cec9454522a1 100644 (file)
--- a/ginac/clifford.h
+++ b/ginac/clifford.h
@@ -169,6 +169,7 @@ ex dirac_gammaR(unsigned char rl = 0);
 
 /** Create a term of the form e_mu * gamma~mu with a unique index mu.
  *
+ *  @param e Original expression
  *  @param dim Dimension of index
  *  @param rl Representation label */
 ex dirac_slash(const ex & e, const ex & dim, unsigned char rl = 0);

diff --git a/ginac/matrix.cpp b/ginac/matrix.cpp
index 954c1fd2a7b35704a6fc873615384122bb8597a3..a1438774feb78389802c87d9b0cf96f7fd32235a 100644 (file)
--- a/ginac/matrix.cpp
+++ b/ginac/matrix.cpp
@@ -953,6 +953,7 @@ matrix matrix::inverse(void) const
  *
  *  @param vars n x p matrix, all elements must be symbols 
  *  @param rhs m x p matrix
+ *  @param algo selects the solving algorithm
  *  @return n x p solution matrix
  *  @exception logic_error (incompatible matrices)
  *  @exception invalid_argument (1st argument must be matrix of symbols)

diff --git a/ginac/normal.cpp b/ginac/normal.cpp
index 9dc983b8ca6116cbcf274e0a14fab8c5befe8d1d..829aaa95331b6df28e5b6cb74c41cde33d44271e 100644 (file)
--- a/ginac/normal.cpp
+++ b/ginac/normal.cpp
@@ -300,7 +300,6 @@ static ex multiply_lcm(const ex &e, const numeric &lcm)
 /** Compute the integer content (= GCD of all numeric coefficients) of an
  *  expanded polynomial.
  *
- *  @param e  expanded polynomial
  *  @return integer content */
 numeric ex::integer_content(void) const
 {
@@ -1004,7 +1003,6 @@ static ex sr_gcd(const ex &a, const ex &b, sym_desc_vec::const_iterator var)
 /** Return maximum (absolute value) coefficient of a polynomial.
  *  This function is used internally by heur_gcd().
  *
- *  @param e  expanded multivariate polynomial
  *  @return maximum coefficient
  *  @see heur_gcd */
 numeric ex::max_coefficient(void) const
@@ -1222,6 +1220,8 @@ static ex heur_gcd(const ex &a, const ex &b, ex *ca, ex *cb, sym_desc_vec::const
  *
  *  @param a  first multivariate polynomial
  *  @param b  second multivariate polynomial
+ *  @param ca pointer to expression that will receive the cofactor of a, or NULL
+ *  @param cb pointer to expression that will receive the cofactor of b, or NULL
  *  @param check_args  check whether a and b are polynomials with rational
  *         coefficients (defaults to "true")
  *  @return the GCD as a new expression */
@@ -1500,7 +1500,7 @@ static exvector sqrfree_yun(const ex &a, const symbol &x)
 /** Compute a square-free factorization of a multivariate polynomial in Q[X].
  *
  *  @param a  multivariate polynomial over Q[X]
- *  @param x  lst of variables to factor in, may be left empty for autodetection
+ *  @param l  lst of variables to factor in, may be left empty for autodetection
  *  @return   a square-free factorization of \p a.
  *
  * \note

diff --git a/ginac/numeric.cpp b/ginac/numeric.cpp
index 1d4de9f5b416d4e997f6d590f0c96ef7edb57e4c..f64914d43416d6285f6c170c87b5a7cc44bfe24b 100644 (file)
--- a/ginac/numeric.cpp
+++ b/ginac/numeric.cpp
@@ -1284,14 +1284,14 @@ const numeric exp(const numeric &x)
 
 /** Natural logarithm.
  *
- *  @param z complex number
+ *  @param x complex number
  *  @return  arbitrary precision numerical log(x).
  *  @exception pole_error("log(): logarithmic pole",0) */
-const numeric log(const numeric &z)
+const numeric log(const numeric &x)
 {
-       if (z.is_zero())
+       if (x.is_zero())
                throw pole_error("log(): logarithmic pole",0);
-       return cln::log(z.to_cl_N());
+       return cln::log(x.to_cl_N());
 }
 
 
@@ -1342,8 +1342,8 @@ const numeric acos(const numeric &x)
 
 /** Arcustangent.
  *
- *  @param z complex number
- *  @return atan(z)
+ *  @param x complex number
+ *  @return atan(x)
  *  @exception pole_error("atan(): logarithmic pole",0) */
 const numeric atan(const numeric &x)
 {
@@ -1924,16 +1924,16 @@ const numeric lcm(const numeric &a, const numeric &b)
 
 
 /** Numeric square root.
- *  If possible, sqrt(z) should respect squares of exact numbers, i.e. sqrt(4)
+ *  If possible, sqrt(x) should respect squares of exact numbers, i.e. sqrt(4)
  *  should return integer 2.
  *
- *  @param z numeric argument
- *  @return square root of z. Branch cut along negative real axis, the negative
- *  real axis itself where imag(z)==0 and real(z)<0 belongs to the upper part
- *  where imag(z)>0. */
-const numeric sqrt(const numeric &z)
+ *  @param x numeric argument
+ *  @return square root of x. Branch cut along negative real axis, the negative
+ *  real axis itself where imag(x)==0 and real(x)<0 belongs to the upper part
+ *  where imag(x)>0. */
+const numeric sqrt(const numeric &x)
 {
-       return cln::sqrt(z.to_cl_N());
+       return cln::sqrt(x.to_cl_N());
 }