Changeset fe919c in git

Timestamp:

Mar 24, 2009, 10:31:49 PM (15 years ago)

Author:

Martin Monerjan

Branches:

(u'spielwiese', 'fe61d9c35bf7c61f2b6cbf1b56e25e2f08d536cc')

Children:

76afcdc23066a190fc8c0d2d82b16b5fd08c0215

Parents:

aba53ce3c77ba50e34a7922b440ad0d9b503f81d

Message:

started doxygenization


git-svn-id: file:///usr/local/Singular/svn/trunk@11587 2c84dea3-7e68-4137-9b89-c4e89433aadc

File:

• kernel/gfan.cc (modified) (4 diffs)

kernel/gfan.cc

@@ -2 +2 @@
 Compute the Groebner fan of an ideal
 $Author: monerjan $
-$Date: 2009-03-24 17:37:40 $
-$Header: /exports/cvsroot-2/cvsroot/kernel/gfan.cc,v 1.19 2009-03-24 17:37:40 monerjan Exp $
-$Id: gfan.cc,v 1.19 2009-03-24 17:37:40 monerjan Exp $
+$Date: 2009-03-24 21:31:49 $
+$Header: /exports/cvsroot-2/cvsroot/kernel/gfan.cc,v 1.20 2009-03-24 21:31:49 monerjan Exp $
+$Id: gfan.cc,v 1.20 2009-03-24 21:31:49 monerjan Exp $
 */
 
@@ -39 +39 @@
 #define gfan_DEBUG
 #endif
-
+/**
+*\brief Class facet
+*       Implements the facet structure
+*
+*/
 class facet
 {
         private:
-                intvec fNormal;         //inner normal, describing the facet uniquely
+                /** inner normal, describing the facet uniquely  */
+                intvec fNormal;         
         public:
-                facet()                 //default constructor. Do I need a constructor of type facet(intvec) ?
+                /** The default constructor. Do I need a constructor of type facet(intvec)? */
+                facet()                 
                 {
                         //fNormal = FN;
-                        this->next=NULL;        //By default each facet is last
+                        // Pointer to next facet.  */
+                        /* Defaults to NULL. This way there is no need to check explicitly */
+                        this->next=NULL; 
                 }
                 
-                ~facet(){;}             //destructor
+                /** The default destructor */
+                ~facet(){;}
+                
                 void setFacetNormal(intvec iv){
                         fNormal = iv;
@@ -62 +72 @@
 };
 
+/**
+*\brief Class gcone
+*       Implements the cone structure
+*/
 /*class gcone
 finally this should become s.th. like gconelib.{h,cc} to provide an API
@@ -98 +112 @@
 }
 
+/** 
+*\brief Compute the representation of a cone
+*
+*       Detailed description goes here
+*
+*\param An ideal
+*
+*\return A pointer to a facet
+*/
 /****** getConeNormals computes the inequalities ***/
 /*INPUT_TYPE: ideal                             */