[DOC] Fix some Doxygen references.

diff --git a/ginac/clifford.h b/ginac/clifford.h
index 5491516c63d0e5acd9a83258014b5a582968c126..0bc896f6b88959e90600379784bf4a4f8ea426e8 100644 (file)
--- a/ginac/clifford.h
+++ b/ginac/clifford.h
@@ -306,7 +306,7 @@ ex remove_dirac_ONE(const ex & e, unsigned char rl = 0, unsigned options = 0);
  *  if e contains at least one, otherwise returns -1 
  *
  *  @param e Expression to be processed
- *  @ignore_ONE defines if clifford_ONE should be ignored in the search*/
+ *  @param ignore_ONE defines if clifford_ONE should be ignored in the search */
 int clifford_max_label(const ex & e, bool ignore_ONE = false);
 
 /** Calculation of the norm in the Clifford algebra. */
@@ -321,9 +321,14 @@ ex clifford_inverse(const ex & e);
  *  @param mu Index (must be of class varidx or a derived class)
  *  @param metr Metric (should be indexed, tensmetric or a derived class, or a matrix)
  *  @param rl Representation label
- *  @param e Clifford unit object
  *  @return Clifford vector with given components */
 ex lst_to_clifford(const ex & v, const ex & mu,  const ex & metr, unsigned char rl = 0);
+
+/** List or vector conversion into the Clifford vector.
+ *
+ *  @param v List or vector of coordinates
+ *  @param e Clifford unit object
+ *  @return Clifford vector with given components */
 ex lst_to_clifford(const ex & v, const ex & e);
 
 /** An inverse function to lst_to_clifford(). For given Clifford vector extracts

diff --git a/ginac/ex.cpp b/ginac/ex.cpp
index 1080062f9de07ef4295bdb035b01d587a9fc1356..eeb7e076fcff0ec33808248d90359612a38e32fd 100644 (file)
--- a/ginac/ex.cpp
+++ b/ginac/ex.cpp
@@ -70,6 +70,8 @@ void ex::dbgprinttree() const
        bp->dbgprinttree();
 }
 
+/** Expand an expression.
+ *  @param options  see GiNaC::expand_options */
 ex ex::expand(unsigned options) const
 {
        if (options == 0 && (bp->flags & status_flags::expanded)) // The "expanded" flag only covers the standard options; someone might want to re-expand with different options

diff --git a/ginac/excompiler.h b/ginac/excompiler.h
index 18d6d2850c6d49e6d0c8359b363eda57b893516f..168b9babd0f890d323dfac2780e4c4d152c9d12d 100644 (file)
--- a/ginac/excompiler.h
+++ b/ginac/excompiler.h
@@ -65,7 +65,8 @@ void compile_ex(const ex& expr, const symbol& sym, FUNCP_1P& fp, const std::stri
  * C code equivalent in double precision. The function pointer has type FUNCP_2P.
  *
  * @param expr Expression to be compiled
- * @param sym Symbol from the expression to become the function parameter
+ * @param sym1 Symbol from the expression to become the first function parameter
+ * @param sym2 Symbol from the expression to become the second function parameter
  * @param fp Returned function pointer
  * @param filename Name of the intermediate source code and so-file. If
  * supplied, these intermediate files will not be deleted
@@ -76,8 +77,8 @@ void compile_ex(const ex& expr, const symbol& sym1, const symbol& sym2, FUNCP_2P
  * Takes an expression and produces a function pointer to the compiled and linked
  * C code equivalent in double precision. The function pointer has type FUNCP_CUBA.
  *
- * @param expr Expression to be compiled
- * @param sym Symbol from the expression to become the function parameter
+ * @param exprs List of expression to be compiled
+ * @param syms Symbols from the expression to become the function parameters
  * @param fp Returned function pointer
  * @param filename Name of the intermediate source code and so-file. If
  * supplied, these intermediate files will not be deleted

diff --git a/ginac/factor.h b/ginac/factor.h
index 798ef41c9d43cff3b6ee36f5e5c0afa59d450945..096e1bc3986244315e7fa39698bff5eb99f28030 100644 (file)
--- a/ginac/factor.h
+++ b/ginac/factor.h
@@ -36,7 +36,7 @@ class ex;
  *  functions or polynomials inside function arguments.
  *
  *  @param[in] poly    expression to factorize
- *  @param[in] option  options to influence the factorization
+ *  @param[in] options see GiNaC::factor_options
  *  @return            factorized expression
  */
 extern ex factor(const ex& poly, unsigned options = 0);

diff --git a/ginac/idx.h b/ginac/idx.h
index c327a320cc0a59b4cea31725a7a9b5a1ddb2589e..09877a8aba9b9cfe1a004ebdf4790f8350ea71ff 100644 (file)
--- a/ginac/idx.h
+++ b/ginac/idx.h
@@ -41,8 +41,7 @@ public:
        /** Construct index with given value and dimension.
         *
         *  @param v Value of index (numeric or symbolic)
-        *  @param dim Dimension of index space (numeric or symbolic)
-        *  @return newly constructed index */
+        *  @param dim Dimension of index space (numeric or symbolic) */
        explicit idx(const ex & v, const ex & dim);
 
        // functions overriding virtual functions from base classes
@@ -119,8 +118,7 @@ public:
         *
         *  @param v Value of index (numeric or symbolic)
         *  @param dim Dimension of index space (numeric or symbolic)
-        *  @param covariant Make covariant index (default is contravariant)
-        *  @return newly constructed index */
+        *  @param covariant Make covariant index (default is contravariant) */
        varidx(const ex & v, const ex & dim, bool covariant = false);
 
        // functions overriding virtual functions from base classes
@@ -169,8 +167,7 @@ public:
         *  @param v Value of index (numeric or symbolic)
         *  @param dim Dimension of index space (numeric or symbolic)
         *  @param covariant Make covariant index (default is contravariant)
-        *  @param dotted Make covariant dotted (default is undotted)
-        *  @return newly constructed index */
+        *  @param dotted Make covariant dotted (default is undotted) */
        spinidx(const ex & v, const ex & dim = 2, bool covariant = false, bool dotted = false);
 
        // functions overriding virtual functions from base classes

diff --git a/ginac/indexed.h b/ginac/indexed.h
index 26ac2c343999d47e873b3969b44829f16f1eb36a..4ef478bfbcfd89d522f2600dd3a3d37fb6fee9d3 100644 (file)
--- a/ginac/indexed.h
+++ b/ginac/indexed.h
@@ -48,23 +48,20 @@ class indexed : public exprseq
 public:
        /** Construct indexed object with no index.
         *
-        *  @param b Base expression
-        *  @return newly constructed indexed object */
+        *  @param b Base expression */
        indexed(const ex & b);
 
        /** Construct indexed object with one index. The index must be of class idx.
         *
         *  @param b Base expression
-        *  @param i1 The index
-        *  @return newly constructed indexed object */
+        *  @param i1 The index */
        indexed(const ex & b, const ex & i1);
 
        /** Construct indexed object with two indices. The indices must be of class idx.
         *
         *  @param b Base expression
         *  @param i1 First index
-        *  @param i2 Second index
-        *  @return newly constructed indexed object */
+        *  @param i2 Second index */
        indexed(const ex & b, const ex & i1, const ex & i2);
 
        /** Construct indexed object with three indices. The indices must be of class idx.
@@ -72,8 +69,7 @@ public:
         *  @param b Base expression
         *  @param i1 First index
         *  @param i2 Second index
-        *  @param i3 Third index
-        *  @return newly constructed indexed object */
+        *  @param i3 Third index */
        indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3);
 
        /** Construct indexed object with four indices. The indices must be of class idx.
@@ -82,8 +78,7 @@ public:
         *  @param i1 First index
         *  @param i2 Second index
         *  @param i3 Third index
-        *  @param i4 Fourth index
-        *  @return newly constructed indexed object */
+        *  @param i4 Fourth index */
        indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3, const ex & i4);
 
        /** Construct indexed object with two indices and a specified symmetry. The
@@ -92,8 +87,7 @@ public:
         *  @param b Base expression
         *  @param symm Symmetry of indices
         *  @param i1 First index
-        *  @param i2 Second index
-        *  @return newly constructed indexed object */
+        *  @param i2 Second index */
        indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2);
 
        /** Construct indexed object with three indices and a specified symmetry.
@@ -103,8 +97,7 @@ public:
         *  @param symm Symmetry of indices
         *  @param i1 First index
         *  @param i2 Second index
-        *  @param i3 Third index
-        *  @return newly constructed indexed object */
+        *  @param i3 Third index */
        indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3);
 
        /** Construct indexed object with four indices and a specified symmetry. The
@@ -115,16 +108,14 @@ public:
         *  @param i1 First index
         *  @param i2 Second index
         *  @param i3 Third index
-        *  @param i4 Fourth index
-        *  @return newly constructed indexed object */
+        *  @param i4 Fourth index */
        indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3, const ex & i4);
 
        /** Construct indexed object with a specified vector of indices. The indices
         *  must be of class idx.
         *
         *  @param b Base expression
-        *  @param iv Vector of indices
-        *  @return newly constructed indexed object */
+        *  @param iv Vector of indices */
        indexed(const ex & b, const exvector & iv);
 
        /** Construct indexed object with a specified vector of indices and
@@ -132,8 +123,7 @@ public:
         *
         *  @param b Base expression
         *  @param symm Symmetry of indices
-        *  @param iv Vector of indices
-        *  @return newly constructed indexed object */
+        *  @param iv Vector of indices */
        indexed(const ex & b, const symmetry & symm, const exvector & iv);
 
        // internal constructors

diff --git a/ginac/normal.cpp b/ginac/normal.cpp
index 8b2bba479b0e9ba3ef0cdb720a2b7fe253b784ad..9dc842f15eb947ffcba286f561200cf250c50645 100644 (file)
--- a/ginac/normal.cpp
+++ b/ginac/normal.cpp
@@ -1428,6 +1428,7 @@ static ex gcd_pf_mul(const ex& a, const ex& b, ex* ca, ex* cb);
  *  @param cb pointer to expression that will receive the cofactor of b, or nullptr
  *  @param check_args  check whether a and b are polynomials with rational
  *         coefficients (defaults to "true")
+ *  @param options  see GiNaC::gcd_options
  *  @return the GCD as a new expression */
 ex gcd(const ex &a, const ex &b, ex *ca, ex *cb, bool check_args, unsigned options)
 {

diff --git a/ginac/pseries.cpp b/ginac/pseries.cpp
index 54fc51bb04646b180539666ad08460997a1a4af0..00188f0147d599d2f1d15ebf52f8362cf6242e74 100644 (file)
--- a/ginac/pseries.cpp
+++ b/ginac/pseries.cpp
@@ -66,8 +66,7 @@ pseries::pseries() { }
  *  non-terminating series.
  *
  *  @param rel_  expansion variable and point (must hold a relational)
- *  @param ops_  vector of {coefficient, power} pairs (coefficient must not be zero)
- *  @return newly constructed pseries */
+ *  @param ops_  vector of {coefficient, power} pairs (coefficient must not be zero) */
 pseries::pseries(const ex &rel_, const epvector &ops_)
   : seq(ops_)
 {