- added documentation to ex_to_series() and series_to_poly()

diff --git a/ginac/series.h b/ginac/series.h
index 7b4e095f19accbf30a571c97038f767672b687ec..5df4d82214d0d68e4b001ebdbcf8c737b95fc178 100644 (file)
--- a/ginac/series.h
+++ b/ginac/series.h
@@ -88,12 +88,26 @@ protected:
 extern const series some_series;
 extern type_info const & typeid_series;
 
 extern const series some_series;
 extern type_info const & typeid_series;
 

-// utility functions
+/** Return a reference to the series object embedded in an expression.
+ *  The result is undefined if the expression does not contain a series
+ *  object at its top level.
+ *
+ *  @param e expression
+ *  @return reference to series object
+ *  @see is_ex_of_type */

 inline const series &ex_to_series(const ex &e)
 {
        return static_cast<const series &>(*e.bp);
 }
 
 inline const series &ex_to_series(const ex &e)
 {
        return static_cast<const series &>(*e.bp);
 }
 

+/** Convert the series object embedded in an expression to an ordinary
+ *  polynomial in the expansion variable. The result is undefined if the
+ *  expression does not contain a series object at its top level.
+ *
+ *  @param e expression
+ *  @return polynomial expression
+ *  @see is_ex_of_type
+ *  @see series::convert_to_poly */

 inline ex series_to_poly(const ex &e)
 {
        return (static_cast<const series &>(*e.bp).convert_to_poly(true));
 inline ex series_to_poly(const ex &e)
 {
        return (static_cast<const series &>(*e.bp).convert_to_poly(true));