X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Ffactor.h;h=5d8ee9f562e01406c1b5194fd995b155715cbf81;hp=5302f211c76fdee18b93714c085ad8f6c5b2844f;hb=2afa71937b3c12cdc70f01213baa8a92be4b604a;hpb=a377cee53b71348235ec36f83afeced7e10288a8

diff --git a/ginac/factor.h b/ginac/factor.h
index 5302f211..5d8ee9f5 100644
--- a/ginac/factor.h
+++ b/ginac/factor.h
@@ -1,10 +1,9 @@
 /** @file factor.h
  *
- *  Polynomial factorization code.
- */
+ *  Polynomial factorization. */
 
 /*
- *  GiNaC Copyright (C) 1999-2008 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2015 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -21,15 +20,27 @@
  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#ifndef __GINAC_FACTOR_H__
-#define __GINAC_FACTOR_H__
+#ifndef GINAC_FACTOR_H
+#define GINAC_FACTOR_H
 
 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
 
-#endif // ndef __GINAC_FACTOR_H__
+#endif // ndef GINAC_FACTOR_H