Added many comments.

[ginac.git] / ginac / factor.h

diff --git a/ginac/factor.h b/ginac/factor.h
index 5302f211c76fdee18b93714c085ad8f6c5b2844f..b54e57b58f29d4dde383f35b0e8a4b29932caf6d 100644 (file)
--- a/ginac/factor.h
+++ b/ginac/factor.h
@@ -1,6 +1,7 @@
 /** @file factor.h
  *
- *  Polynomial factorization code.
+ *  Polynomial factorization.
+ *
  */
 
 /*
@@ -28,6 +29,18 @@ namespace GiNaC {
 
 class ex;
 
+/** Factorizes univariate and multivariate polynomials.
+ *  
+ *  The default option is factor_options::polynomial, which means that factor()
+ *  will only factorize an expression if it is a proper polynomial (i.e. the
+ *  flag info_flags::polynomial is set). Given the option factor_options::all,
+ *  factor() will factorize all subexpressions, e.g. polynomials containing
+ *  functions or polynomials inside function arguments.
+ *
+ *  @param[in] poly    expression to factorize
+ *  @param[in] option  options to influence the factorization
+ *  @return            factorized expression
+ */
 extern ex factor(const ex& poly, unsigned options = 0);
 
 } // namespace GiNaC