Add missing class descriptions.

git-svn-id: http://root.cern.ch/svn/root/trunk@21453 27541ba8-7e3a-0410-8455-c3a389f83636

gl/inc/TGLContext.h

@@ -71,7 +71,7 @@ private:
    TGLContext(const TGLContext &);
    TGLContext &operator = (const TGLContext &);
 
-   ClassDef(TGLContext, 0)//This class controls internal gl-context resources.
+   ClassDef(TGLContext, 0) // Control internal gl-context resources.
 };
 
 

gl/inc/TGLFormat.h

@@ -35,9 +35,9 @@ class TGLFormat {
 public:
    enum EFormatOptions {
       kDoubleBuffer = 1,
-      kDepth = 2,
-      kAccum = 4,
-      kStencil = 8
+      kDepth        = 2,
+      kAccum        = 4,
+      kStencil      = 8
    };
 
 private:
@@ -72,7 +72,7 @@ public:
    Bool_t IsDoubleBuffered()const;
    void   SetDoubleBuffered(Bool_t db);
 
-   ClassDef(TGLFormat, 0)//Describes gl buffer format
+   ClassDef(TGLFormat, 0) // Describes GL buffer format.
 };
 
 #endif

gl/inc/TGLPlotPainter.h

@@ -62,8 +62,6 @@ private:
 
 public:
    TGLBoxCut(const TGLPlotBox *plotBox);
-   //Class has ClassDef macro == virtual functions, so we need
-   //explicitly declared/defined dtor to supress warnings from g++
    virtual ~TGLBoxCut();
 
    void   TurnOnOff();

gl/inc/TGLTF3Painter.h

@@ -160,7 +160,7 @@ private:
    TGLIsoPainter(const TGLIsoPainter &);
    TGLIsoPainter &operator = (const TGLIsoPainter &);
 
-   ClassDef(TGLIsoPainter, 0) //Iso option for TH3
+   ClassDef(TGLIsoPainter, 0) // Iso option for TH3.
 };
 
 #endif

gl/inc/TGLWidget.h

@@ -31,14 +31,6 @@
 
 class TGLWidget;
 
-/*
-   Auxiliary "widget container" class.
-   Does not throw (base classe can throw?).
-   Immutable - after constructed, fOwner is
-   invariant, cannot change.
-   Non-copyable.
-*/
-
 class TGLWidgetContainer : public TGCompositeFrame {
 private:
    TGLWidget *fOwner;
@@ -62,40 +54,6 @@ private:
    ClassDef(TGLWidgetContainer, 0)//Auxilary widget container class.
 };
 
-/*
-   TGLWidget. GL window with context. _Must_ _have_ a parent window
-   (the 'parent' parameter of ctors). The current version inherits
-   TGCanvas (I'm not sure about future versions), probably, in future
-   multiple inheritance will be added - the second
-   base class will be TGLPaintDevice or something like this.
-
-   Usage:
-   - Simply create TGLWidget as an embedded widget, and
-     connect your slots to signals you need: HandleExpose, HandleConfigureNotify, etc.
-     In your slots you can use gl API directly - under Win32 TGLWidget switches
-     between threads internally (look TGLPShapeObjEditor for such usage).
-   - You can write your own class, derived from TGLWidget, with PaintGL and InitGL
-     overriden.
-
-   Resources (and invariants):
-   -fContainer (TGLWidgetContainer) - controlled by std::auto_ptr
-   -fWindowIndex - controlled manually (see CreateWidget and dtor)
-   -fGLContext - controlled by std::auto_ptr
-   -visual info for X11 version, controlled manually (see CreateGLContainer and dtor)
-
-   Exceptions:
-   -can be thrown only during construction.
-   -under win32 class does not throw itself (but some internal operations can throw)
-   -under X11 can throw std::runtime_error (from CreateGLContext).
-   -In case of exceptions resources will be freed.
-
-   TGLWidget object is immutable as far as it was created.
-
-   Boolean parameter defines, if you want to grab user's input or not.
-   By default you want, but for example when not - see TGLPShapeObjEditor.
-
-   Non-copyable.
-*/
 
 class TGLWidget : public TGCanvas, public TGLPaintDevice {
    friend class TGLContext;

gl/src/TArcBall.cxx

@@ -15,6 +15,11 @@
 
 const Double_t Epsilon = 1.0e-5;
 
+//______________________________________________________________________________
+//
+// Implements the arc-ball rotation manipulator.
+// Used by plot-painters.
+
 ClassImp(TArcBall)
 
 //Arcball sphere constants:

gl/src/TF2GL.cxx

@@ -25,9 +25,9 @@
 #include "TGLIncludes.h"
 
 //______________________________________________________________________
-// TF2GL
-//
 //
+// GL renderer for TF2.
+// TGLPlotPainter is used internally.
 
 ClassImp(TF2GL)
 

gl/src/TGLAdapter.cxx

@@ -11,6 +11,10 @@
 
 #include "TGLAdapter.h"
 
+//______________________________________________________________________________
+//
+// Allow plot-painters to be used for gl-inpad and gl-viewer.
+
 ClassImp(TGLAdapter)
 
 //______________________________________________________________________________

gl/src/TGLAxis.cxx

@@ -19,14 +19,13 @@
 #include "TMath.h"
 #include "THLimitsFinder.h"
 
-ClassImp(TGLAxis)
-
 //______________________________________________________________________________
 /* Begin_Html
 <center><h2>GL Axis</h2></center>
 To draw a 3D axis in a GL window. The labels are drawn using FTGL.
 End_Html */
 
+ClassImp(TGLAxis)
 
 //______________________________________________________________________________
 TGLAxis::TGLAxis(): TAttLine(1,1,1), TAttText(20,0.,1,42,0.04)

gl/src/TGLBoxPainter.cxx

@@ -14,8 +14,12 @@
 #include "TGLBoxPainter.h"
 #include "TGLIncludes.h"
 
-ClassImp(TGLBoxPainter)
+//______________________________________________________________________________
+//
+// Paints TH3 histograms by rendering variable-sized bozes matching the
+// bin contents.
 
+ClassImp(TGLBoxPainter)
 
 //______________________________________________________________________________
 TGLBoxPainter::TGLBoxPainter(TH1 *hist, TGLOrthoCamera *cam, TGLPlotCoordinates *coord, TGLPaintDevice *dev)

gl/src/TGLClipSetEditor.cxx

@@ -21,9 +21,9 @@
 #include "TGLViewerEditor.h"
 
 //______________________________________________________________________________
-// TGLClipSetSubEditor
-//
 //
+// GUI sub-editor for TGLClipSet.
+
 
 ClassImp(TGLClipSetSubEditor)
 
@@ -204,9 +204,8 @@ void TGLClipSetSubEditor::UpdateViewerClip()
 
 
 //______________________________________________________________________________
-// TGLClipSetEditor
-//
 //
+// GUI editor for TGLClipSet.
 
 ClassImp(TGLClipSetEditor)
 

gl/src/TGLContext.cxx

@@ -33,6 +33,11 @@
 #include "TGLFormat.h"
 #include "TGLUtil.h"
 
+//______________________________________________________________________________
+//
+// This class encapsulates window-system specific information about a
+// GL-context and alows their proper management in ROOT.
+
 ClassImp(TGLContext)
 
 //______________________________________________________________________________
@@ -385,7 +390,6 @@ TGLContext *TGLContext::GetCurrent()
 
 
 //______________________________________________________________________________
-// TGLContextIdentity
 //
 // Identifier of a shared GL-context.
 // Objects shared among GL-contexts include:

gl/src/TGLCylinder.cxx

@@ -10,6 +10,7 @@
  * For the licensing terms see $ROOTSYS/LICENSE.                         *
  * For the list of contributors see $ROOTSYS/README/CREDITS.             *
  *************************************************************************/
+
 #include "TGLCylinder.h"
 #include "TGLRnrCtx.h"
 #include "TGLIncludes.h"
@@ -493,6 +494,12 @@ void TCylinderSegMesh::Draw() const
    glDisableClientState(GL_NORMAL_ARRAY);
 }
 
+
+//______________________________________________________________________________
+//
+// Implements a native ROOT-GL cylinder that can be rendered at
+// different levels of detail.
+
 ClassImp(TGLCylinder)
 
 //______________________________________________________________________________

gl/src/TGLFaceSet.cxx

@@ -10,6 +10,7 @@
  * For the licensing terms see $ROOTSYS/LICENSE.                         *
  * For the list of contributors see $ROOTSYS/README/CREDITS.             *
  *************************************************************************/
+
 #include "TGLFaceSet.h"
 #include "TGLRnrCtx.h"
 #include "TGLIncludes.h"
@@ -54,6 +55,12 @@ static GLUtriangulatorObj *GetTesselator()
    return singleton.fTess;
 }
 
+
+//______________________________________________________________________________
+//
+// Implementss a native ROOT-GL representation of an arbitrary set of
+// polygons.
+
 ClassImp(TGLFaceSet)
 
 //______________________________________________________________________________

gl/src/TGLFormat.cxx

@@ -13,6 +13,10 @@
 
 #include "TGLFormat.h"
 
+//______________________________________________________________________________
+//
+// Encapsulation of format / contents of an OpenGL buffer.
+
 ClassImp(TGLFormat)
 
 //______________________________________________________________________________

gl/src/TGLLegoPainter.cxx

@@ -27,6 +27,11 @@
 #include "TGLOrthoCamera.h"
 #include "TGLIncludes.h"
 
+//______________________________________________________________________________
+//
+// Plot-painter implementing LEGO rendering of TH2 histograms in
+// cartesian, polar, cylindrical and spherical coordinates.
+
 ClassImp(TGLLegoPainter)
 
 //______________________________________________________________________________

gl/src/TGLPShapeObjEditor.cxx

@@ -31,6 +31,9 @@
 #include "Buttons.h"
 
 //______________________________________________________________________________
+//
+// GUI editor for TGLPShapeObj.
+
 ClassImp(TGLPShapeObjEditor)
 
 enum EGeometry {

gl/src/TGLParametricEquationGL.cxx

@@ -23,9 +23,9 @@
 #include "TGLIncludes.h"
 
 //______________________________________________________________________
-// TGLParametricEquationGL
-//
 //
+// GL-renderer wrapper for TGLParametricEquation.
+// This allows rendering of parametric-equations in standard GL viewer.
 
 ClassImp(TGLParametricEquationGL)
 

gl/src/TGLPhysicalShape.cxx

@@ -22,7 +22,11 @@
 #include "TClass.h"
 #include "TError.h"
 
+/******************************************************************************/
 // TGLPhysicalShape
+/******************************************************************************/
+
+//______________________________________________________________________________
 //
 // Concrete physical shape - a GL drawable. Physical shapes are the
 // objects the user can actually see, select, move in the viewer. It is

gl/src/TGLPlotBox.cxx

@@ -5,6 +5,11 @@
 #include "TGLIncludes.h"
 #include "TGLPlotBox.h"
 
+//______________________________________________________________________________
+//
+// Implementation of a box around a histogram/function for
+// plot-painters.
+
 ClassImp(TGLPlotBox)
 
 const Int_t TGLPlotBox::fgFramePlanes[][4] =