1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-14 13:30:48 +03:00

0024784: Move documentation in CDL files to proper location

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

View File

@@ -59,61 +59,37 @@ is
class DocumentTool;
---Purpose: Defines sections structure of an XDE document.
-- attribute marking CAF document as being DECAF document.
-- Creates the sections structure of the document.
class Location;
---Purpose: attribute to store TopLoc_Location
class Color;
---Purpose: attribute to store color
class DimTol;
---Purpose: attribute to store dimension and tolerance
class Datum;
---Purpose: attribute to store datum
class Material;
---Purpose: attribute to store material
class Volume;
---Purpose: attribute to store volume
class Area;
---Purpose: attribute to store area
class Centroid;
---Purpose: attribute to store centroid
class ShapeTool;
---Purpose: attribute containing Shapes section of DECAF document.
-- Provide tools for management of Shapes section.
class ShapeMapTool;
---Purpose: attribute containing map of sub shapes
class ColorTool;
---Purpose: attribute containing Colors section of DECAF document.
-- Provide tools for management of Colors section of document.
class DimTolTool;
---Purpose: attribute containing DimTol section of DECAF document.
-- Provide tools for management of DimTol section of document.
class LayerTool;
---Purpose: attribute containing Layers section og DECAF document.
-- Provide tools for management of Layers section of document.
class MaterialTool;
---Purpose: attribute containing Materials section og DECAF document.
-- Provide tools for management of Materialss section of document.
class GraphNode;
---Purpose: attribute containg sequence of father's and chaild's labels.
-- Provide create and work with Graph in XCAFDocument.
class GraphNodeSequence instantiates Sequence from TCollection
(GraphNode from XCAFDoc);
---Purpose: class for containing GraphNodes.

View File

@@ -15,7 +15,7 @@
class Area from XCAFDoc inherits Attribute from TDF
---Purpose:
---Purpose: attribute to store area
uses
Attribute from TDF,

View File

@@ -15,7 +15,7 @@
class Centroid from XCAFDoc inherits Attribute from TDF
---Purpose:
---Purpose: attribute to store centroid
uses
Pnt from gp,

View File

@@ -15,7 +15,7 @@
class Color from XCAFDoc inherits Attribute from TDF
---Purpose:
---Purpose: attribute to store color
uses
Color from Quantity,

View File

@@ -19,6 +19,7 @@ class ColorTool from XCAFDoc inherits Attribute from TDF
-- of TopoDS_Shape in and from TDocStd_Document
-- A Document is intended to hold different
-- attributes of ONE shape and it's sub-shapes
-- Provide tools for management of Colors section of document.
uses
Color from Quantity,

View File

@@ -15,7 +15,7 @@
class Datum from XCAFDoc inherits Attribute from TDF
---Purpose:
---Purpose: attribute to store datum
uses
Label from TDF,

View File

@@ -15,7 +15,7 @@
class DimTol from XCAFDoc inherits Attribute from TDF
---Purpose:
---Purpose: attribute to store dimension and tolerance
uses
Label from TDF,

View File

@@ -18,8 +18,9 @@ class DimTolTool from XCAFDoc inherits Attribute from TDF
---Purpose: Provides tools to store and retrieve attributes (colors)
-- of TopoDS_Shape in and from TDocStd_Document
-- A Document is intended to hold different
-- attributes of ONE shape and it's sub-shapes
-- attributes of ONE shape and it's sub-shapes.
-- Attribute containing DimTol section of DECAF document.
-- Provide tools for management of DimTol section of document.
uses
Shape from TopoDS,
Label from TDF,

View File

@@ -16,7 +16,8 @@
class DocumentTool from XCAFDoc inherits Attribute from TDF
---Purpose: Defines sections structure of an XDE document.
-- attribute marking CAF document as being DECAF document.
-- Creates the sections structure of the document.
uses
Label from TDF,
Document from TDocStd,

View File

@@ -16,7 +16,9 @@
class GraphNode from XCAFDoc inherits Attribute from TDF
---Purpose: This attribute allow user multirelation tree of labels.
-- This GraphNode is experimental Graph that not control looping and redundance.
-- This GraphNode is experimental Graph that not control looping and redundance.
-- Attribute containg sequence of father's and child's labels.
-- Provide create and work with Graph in XCAFDocument.
uses
GUID from Standard,

View File

@@ -19,7 +19,7 @@ class LayerTool from XCAFDoc inherits Attribute from TDF
-- of TopoDS_Shape in and from TDocStd_Document
-- A Document is intended to hold different
-- attributes of ONE shape and it's sub-shapes
-- Provide tools for management of Layers section of document.
uses
Shape from TopoDS,
Label from TDF,

View File

@@ -15,7 +15,7 @@
class Location from XCAFDoc inherits Attribute from TDF
---Purpose:
---Purpose: attribute to store TopLoc_Location
uses
Location from TopLoc,

View File

@@ -14,6 +14,8 @@
-- commercial license or contractual agreement.
class Material from XCAFDoc inherits Attribute from TDF
---Purpose: attribute to store material
uses
Label from TDF,
RelocationTable from TDF,

View File

@@ -19,6 +19,7 @@ class MaterialTool from XCAFDoc inherits Attribute from TDF
-- of TopoDS_Shape in and from TDocStd_Document
-- A Document is intended to hold different
-- attributes of ONE shape and it's sub-shapes
-- Provide tools for management of Materialss section of document.
uses
Shape from TopoDS,

View File

@@ -14,6 +14,7 @@
-- commercial license or contractual agreement.
class ShapeMapTool from XCAFDoc inherits Attribute from TDF
---Purpose: attribute containing map of sub shapes
uses

View File

@@ -17,6 +17,8 @@ class ShapeTool from XCAFDoc inherits Attribute from TDF
---Purpose: A tool to store shapes in an XDE
-- document in the form of assembly structure, and to maintain this structure.
-- Attribute containing Shapes section of DECAF document.
-- Provide tools for management of Shapes section.
-- The API provided by this class allows to work with this
-- structure regardless of its low-level implementation.
-- All the shapes are stored on child labels of a main label which is

View File

@@ -15,7 +15,7 @@
class Volume from XCAFDoc inherits Attribute from TDF
---Purpose:
---Purpose: attribute to store volume
uses
Attribute from TDF,