Update comments

[modules/gui.git] / src / VTKViewer / VTKViewer_Actor.h

diff --git a/src/VTKViewer/VTKViewer_Actor.h b/src/VTKViewer/VTKViewer_Actor.h
index 557af907defb29fc82d84f803ff764e925da377b..ad050d3216331974bac23e8cbc310757a4257a9e 100755 (executable)
--- a/src/VTKViewer/VTKViewer_Actor.h
+++ b/src/VTKViewer/VTKViewer_Actor.h
@@ -22,16 +22,19 @@ class VTKViewer_PassThroughFilter;
 
 #define VTKViewer_POINT_SIZE 3
 /*! \class vtkLODActor
- * \brief For more information see <a href="http://www.vtk.org/">VTK documentation
+ * \brief For more information see <a href="http://www.vtk.org/">VTK documentation</a>
  */
 class VTKVIEWER_EXPORT VTKViewer_Actor : public vtkLODActor
 {
 public:
+  /*!Create new instance of actor.*/
   static VTKViewer_Actor* New();
 
   vtkTypeMacro( VTKViewer_Actor, vtkLODActor );
 
+  /*!Get name of the actor*/
   virtual const char* getName() { return myName.c_str(); }
+  /*!Set name of the actor*/
   virtual void setName(const char* theName){ myName = theName;}
 
   //! To generate highlight automaticaly
@@ -59,19 +62,20 @@ public:
   virtual void RemoveFromRender(vtkRenderer* theRenderer);
 
 
-  /*! For selection mapping purpose */
+  /** @name For selection mapping purpose */
+  //@{
   virtual int GetNodeObjId(int theVtkID) { return theVtkID;}
   virtual float* GetNodeCoord(int theObjID);
 
   virtual int GetElemObjId(int theVtkID) { return theVtkID;}
   virtual vtkCell* GetElemCell(int theObjID);
+  //@}
 
   virtual int GetObjDimension( const int theObjId );
 
   virtual void SetMapper(vtkMapper* theMapper); 
   virtual vtkDataSet* GetInput(); 
 
-
   virtual void SetTransform(VTKViewer_Transform* theTransform); 
   virtual unsigned long int GetMTime();
 
@@ -81,8 +85,9 @@ public:
   virtual int getDisplayMode();
   virtual void setDisplayMode(int theMode);
 
-  //! Infinitive means actor without size (point for example),
-  //! which is not taken into account in calculation of boundaries of the scene
+  /*! Infinitive means actor without size (point for example), \n
+   * which is not taken into account in calculation of boundaries of the scene
+   */
   void SetInfinitive(bool theIsInfinite) { myIsInfinite = theIsInfinite; }
   virtual bool IsInfinitive();
     
@@ -93,26 +98,42 @@ public:
   virtual void Render(vtkRenderer *, vtkMapper *);
 
 protected:
+  /*!resolve coincedent topology flag*/
   bool myIsResolveCoincidentTopology;
+  /*!polygon offset factor*/
   float myPolygonOffsetFactor;
+  /*!polygon offset units*/
   float myPolygonOffsetUnits;
 
+  /*!Actor name.*/
   std::string myName;
 
+  /*!preview property*/
   vtkProperty *PreviewProperty;
+  /*!preselected flag*/
   bool myIsPreselected;
 
+  /*!opacity*/
   float myOpacity;
+  /*!highlighted flag*/
   bool myIsHighlighted;
+  /*!display mode*/
   int myDisplayMode;
+  /*!infinite flag*/
   bool myIsInfinite;
 
+  /*!store mapping flag*/
   bool myStoreMapping;
+  /*!geometry filter*/
   VTKViewer_GeometryFilter *myGeomFilter;
+  /*!transform filter*/
   VTKViewer_TransformFilter *myTransformFilter;
+  /*!vector of passive filters(siz filters used)*/
   std::vector<VTKViewer_PassThroughFilter*> myPassFilter;
 
+  /*!presentation mode*/
   int myRepresentation;
+  /*!property*/
   vtkProperty *myProperty;
 
   //! Main method, which calculate output.