Changeset b52d27 in git for factory/variable.h

Timestamp:

Jun 13, 2014, 2:48:44 PM (10 years ago)

Author:

Martin Lee <martinlee84@…>

Branches:

(u'spielwiese', '2a584933abf2a2d3082034c7586d38bb6de1a30a')

Children:

d87069c50888d28eb107ade8c7418040795ac0d4

Parents:

086f3ec7ab7655f9627e1c40dd022bf8494b12b1

git-author:

Martin Lee <martinlee84@web.de>2014-06-13 14:48:44+02:00

git-committer:

Martin Lee <martinlee84@web.de>2014-06-17 17:12:29+02:00

Message:

chg: more docu changes

File:

• factory/variable.h (modified) (3 diffs)

factory/variable.h

@@ -1 +1 @@
 /* emacs edit mode for this file is -*- C++ -*- */
 
+/**
+ * @file variable.h
+ *
+ * operations on variables
+**/
 #ifndef INCL_VARIABLE_H
 #define INCL_VARIABLE_H
@@ -22 +27 @@
 class CanonicalForm;
 
+/**
+ * factory's class for variables
+**/
 class Variable
 {
@@ -71 +79 @@
 #endif /* NOSTREAMIO */
     friend void swap_levels();
+    /** returns a symbolic root of polynomial with name @a name.
+     *  Use it to define algebraic variables
+     *  @note: algebraic variables have a level < 0
+    **/
     friend Variable rootOf( const CanonicalForm &, char name );
 };
+
+/** returns a symbolic root of polynomial with name @a name
+ *  Use it to define algebraic variables
+ *  @note: algebraic variables have a level < 0
+**/
 Variable rootOf( const CanonicalForm &, char name = '@' );