OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +03:00
Code Activity

0024784: Move documentation in CDL files to proper location

Browse Source 
Mostly duplicated comments were removed and missing ones were moved
into dedicated class CDL files.
Some more duplicated comments were removed from CDL files.
Correction of merge
This commit is contained in:
ski
2014-05-29 16:05:47 +04:00
committed by apn
parent bdd1223f46
commit ff8178ef85
533 changed files with 1047 additions and 2921 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
src/Aspect/Aspect.cdl
View File

@@ -93,7 +93,7 @@ is
-- G002A study
imported CLayer2d;
---Purpose: Defines the C structure <alayer>
---Category: Imported types
imported RGBPixel;
@@ -101,25 +101,15 @@ is
primitive Handle;
primitive Drawable;
---Purpose:
-- To manage Drawable
primitive Display;
---Purpose:
-- To manage Display
primitive RenderingContext;
---Purpose:
-- To manage 2D or 3D graphic context
imported GraphicCallbackProc;
---Purpose:
-- To manage client post display
-- 22-03-04 OCC4895 SAN High-level interface for controlling polygon offsets
imported PolygonOffsetMode;
---Purpose:
-- Enumeration for polygon offset modes
---------------------
-- Category: Pointers
@@ -214,25 +204,18 @@ is
------------------------------
deferred class ColorMap;
---Purpose: Defines a color map.
---Category: Classes Color map
class ColorCubeColorMap;
---Purpose: Associates a index and a color in the "ColorCube" space.
---Category: Classes Color map
class ColorRampColorMap;
---Purpose: Associates a index and a color in the linear "ColorRamp"
-- space.
---Category: Classes Color map
class GenericColorMap;
---Purpose: Associates an index and a color.
---Category: Classes Color map
class ColorMapEntry;
---Purpose: Defines an entry in the color map :
-- an index and a color.
---Category: Classes Color map
------------------------------
@@ -240,15 +223,12 @@ is
------------------------------
deferred class Pixel;
---Purpose: Defines a picture element.
---Category: Classes Pixel
class IndexPixel;
---Purpose:
---Category: Classes Pixel
class ColorPixel;
---Purpose:
---Category: Classes Pixel
---------------------------
@@ -256,18 +236,12 @@ is
---------------------------
deferred class AspectLine;
---Purpose: Creates and updates a group of graphic attributes
-- for primitives 'Line'
---Category: Classes Aspect
deferred class AspectMarker;
---Purpose: Creates and updates a group of graphic attributes
-- for primitives 'Marker'.
---Category: Classes Aspect
deferred class AspectFillArea;
---Purpose: Creates and updates a group of graphic attributes
-- for primitives 'Face'.
---Category: Classes Aspect
--------------------
@@ -275,79 +249,57 @@ is
--------------------
class Background;
---Purpose: Defines a window background
---Category: Classes
class GradientBackground;
---Purpose: Defines a window gradient background
---Category: Classes
class Edge;
---Purpose: Defines an edge.
---Category: Classes
class GenId;
---Purpose: Creates and controles all identifiers.
---Category: Classes
class FontStyle;
---Purpose: Defines a Font Style
---Category: The classes
class FontMapEntry;
---Purpose: Defines an entry in the Font map :
-- an index and a text Font.
---Category: Classes Font map
class FontMap;
---Purpose: Associates an index and a text Font entry.
---Category: The classes
class WidthMapEntry;
---Purpose: Defines an entry in the Width map :
-- an index and a line Width.
---Category: Classes Width map
class WidthMap;
---Purpose: Associates an index and a line width entry.
---Category: The classes
class LineStyle;
---Purpose: Defines a Line Style
---Category: The classes
class TypeMap;
---Purpose: Associates an index and a line type entry.
---Category: The classes
class TypeMapEntry;
---Purpose: Defines an entry in the Type map :
-- an index and a line style.
---Category: Classes Type map
class MarkerStyle;
---Purpose: Defines a Marker Style
---Category: The classes
class MarkMap;
---Purpose: Associates an index and a Marker entry.
---Category: The classes
class MarkMapEntry;
---Purpose: Defines an entry in the Marker map :
-- an index and a marker style.
---Category: Classes Mark map
deferred class Window;
---Purpose: Defines a window.
---Category: Classes
deferred class Driver;
---Purpose: Defines a virtual driver.
---Category: Classes
deferred class WindowDriver;
---Purpose: Defines a virtual driver associated to a window.
---Category: Classes
deferred class Grid;
@@ -355,13 +307,10 @@ is
class CircularGrid;
deferred class ColorScale;
---Purpose: Defines a color scale for viewer.
imported DisplayConnection;
---Purpose: Creates and provides connection with X server.
imported DisplayConnection_Handle;
---Purpose: Handle for DisplayConnection;
-------------------------
-- Category: Enumerations

1
src/Aspect/Aspect_CLayer2d.hxx
View File

@@ -17,6 +17,7 @@
/*==== */
/*==== Implementation: This is a primitive type implemented with typedef */
/*============================================================================*/
// Defines the C structure <alayer>
#ifndef _Aspect_CLayer2d_HeaderFile
#define _Aspect_CLayer2d_HeaderFile

1
src/Aspect/Aspect_ColorCubeColorMap.cdl
View File

@@ -19,6 +19,7 @@ class ColorCubeColorMap from Aspect inherits ColorMap from Aspect
---Version: 0.0
---Purpose: This class defines a ColorCube ColorMap object.
-- Associates a index and a color in the "ColorCube" space.
---Keywords:
---Warning:
---References:

1
src/Aspect/Aspect_ColorRampColorMap.cdl
View File

@@ -19,6 +19,7 @@ class ColorRampColorMap from Aspect inherits ColorMap from Aspect
---Version: 0.0
---Purpose: This class defines a ColorRampColorMap object.
-- Associates a index and a color in the linear "ColorRamp" space.
---Keywords:
---Warning:
---References:

2
src/Aspect/Aspect_ColorScale.cdl
View File

@@ -14,7 +14,7 @@
-- commercial license or contractual agreement.
deferred class ColorScale from Aspect inherits TShared from MMgt
---Purpose: Defines a color scale for viewer.
uses
TypeOfColorScaleData from Aspect,

1
src/Aspect/Aspect_Display.hxx
View File

@@ -17,6 +17,7 @@
/*==== "V3d" */
/*==== Implementation: This is a primitive type implemented with typedef */
/*============================================================================*/
// To manage Display
#ifndef _Aspect_Display_HeaderFile
#define _Aspect_Display_HeaderFile

2
src/Aspect/Aspect_DisplayConnection_Handle.hxx
View File

@@ -16,6 +16,8 @@
#include <Standard_Transient.hxx>
// Handle for DisplayConnection;
class Aspect_DisplayConnection;
DEFINE_STANDARD_HANDLE(Aspect_DisplayConnection, Standard_Transient)
typedef Handle(Aspect_DisplayConnection) Aspect_DisplayConnection_Handle;

1
src/Aspect/Aspect_Drawable.hxx
View File

@@ -17,6 +17,7 @@
/*==== "Xw" & "WNT" */
/*==== Implementation: This is a primitive type implemented with typedef */
/*============================================================================*/
// To manage Drawable
#ifndef _Aspect_Drawable_HeaderFile
#define _Aspect_Drawable_HeaderFile

1
src/Aspect/Aspect_FontMap.cdl
View File

@@ -19,6 +19,7 @@ class FontMap from Aspect inherits TShared from MMgt
---Version: 0.0
---Purpose: This class defines a FontMap object.
-- Associates an index and a text Font entry.
---Keywords:
---Warning:
---References:

1
src/Aspect/Aspect_GenericColorMap.cdl
View File

@@ -20,6 +20,7 @@ class GenericColorMap from Aspect inherits ColorMap from Aspect
---Level: Public
---Purpose: This class defines a GenericColorMap object.
-- Associates an index and a color.
---Keywords:
---Warning:
---References:

2
src/Aspect/Aspect_GraphicCallbackProc.hxx
View File

@@ -14,6 +14,8 @@
#ifndef _Aspect_GraphicCallbackProc_HeaderFile
#define _Aspect_GraphicCallbackProc_HeaderFile
// To manage client post display
#include <Aspect_Display.hxx>
#include <Aspect_Drawable.hxx>
#include <Aspect_RenderingContext.hxx>

1
src/Aspect/Aspect_MarkMap.cdl
View File

@@ -19,6 +19,7 @@ class MarkMap from Aspect inherits TShared from MMgt
---Version: 0.0
---Purpose: This class defines a MarkMap object.
-- Associates an index and a Marker entry.
---Keywords:
---Warning:
---References:

1
src/Aspect/Aspect_Pixel.cdl
View File

@@ -19,6 +19,7 @@ deferred class Pixel from Aspect inherits Storable
---Version: 0.0
---Purpose: This class defines a Pixel.
-- Defines a picture element.
---Keywords:
---Warning:
---References:

2
src/Aspect/Aspect_PolygonOffsetMode.hxx
View File

@@ -16,6 +16,8 @@
#ifndef ASPECT_POLYGONOFFSETMODE_HEADER
#define ASPECT_POLYGONOFFSETMODE_HEADER
// Enumeration for polygon offset modes
typedef enum
{
Aspect_POM_Off = 0x00, /* all polygon offset modes disabled */

1
src/Aspect/Aspect_RenderingContext.hxx
View File

@@ -17,6 +17,7 @@
/*==== "V3d" */
/*==== Implementation: This is a primitive type implemented with typedef */
/*============================================================================*/
// To manage 2D or 3D graphic context
#ifndef _Aspect_RenderingContext_HeaderFile
#define _Aspect_RenderingContext_HeaderFile

1
src/Aspect/Aspect_TypeMap.cdl
View File

@@ -19,6 +19,7 @@ class TypeMap from Aspect inherits TShared from MMgt
---Version: 0.0
---Purpose: This class defines a TypeMap object.
-- Associates an index and a line type entry.
---Keywords:
---Warning:
---References:

1
src/Aspect/Aspect_WidthMap.cdl
View File

@@ -19,6 +19,7 @@ class WidthMap from Aspect inherits TShared from MMgt
---Version: 0.0
---Purpose: This class defines a WidthMap object.
-- Associates an index and a line width entry.
---Keywords:
---Warning:
---References:

2
src/Aspect/Aspect_Window.cdl
View File

@@ -14,7 +14,7 @@
-- commercial license or contractual agreement.
deferred class Window from Aspect
---Purpose: Defines a window.
inherits
TShared from MMgt