mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-09 13:22:24 +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:
@@ -51,10 +51,8 @@ is
|
||||
-- ==============================================================
|
||||
|
||||
class Data;
|
||||
---Purpose: The root class of this structure.
|
||||
|
||||
class Label;
|
||||
---Purpose: A label is a feature in the structure.
|
||||
|
||||
imported HAllocator;
|
||||
imported LabelNode;
|
||||
@@ -62,109 +60,71 @@ is
|
||||
pointer LabelNodePtr to LabelNode from TDF;
|
||||
|
||||
deferred class Attribute;
|
||||
---Purpose: A class each application has to implement. It is
|
||||
-- used to contain the application data.
|
||||
|
||||
class TagSource;
|
||||
---Purpose: this attribute may be used for automatic delivery of
|
||||
-- labels under a given label.
|
||||
|
||||
class Reference;
|
||||
---Purpose: this attribute is used to store in the framework a
|
||||
-- reference to an other label.
|
||||
|
||||
|
||||
|
||||
---Category: DF Copy algorithms
|
||||
-- ==============================================================
|
||||
|
||||
class ClosureMode;
|
||||
---Purpose: This class provides options closure management.
|
||||
|
||||
|
||||
class ClosureTool;
|
||||
---Purpose: This class gives services around the transitive
|
||||
-- enclosure of a set of information, starting from a
|
||||
-- list of label.
|
||||
|
||||
class CopyTool;
|
||||
---Purpose: This class gives services around copy/paste actions.
|
||||
|
||||
|
||||
class CopyLabel;
|
||||
---Purpose: This class gives copy of source label hierarchy
|
||||
|
||||
|
||||
class ComparisonTool;
|
||||
---Purpose: This class gives services around the comparison
|
||||
-- between two sets of information.
|
||||
|
||||
---Category: DF Transaction & Delta
|
||||
-- ==============================================================
|
||||
|
||||
class Transaction;
|
||||
---Purpose: This class offers services to open, commit or
|
||||
-- abort a transaction in a more secure way than
|
||||
-- using Data from TDF.
|
||||
|
||||
class Delta;
|
||||
---Purpose: A set of AttributeDelta for a given transaction
|
||||
-- number and reference time number.
|
||||
|
||||
deferred class AttributeDelta;
|
||||
---Purpose: Delta for a given attribute.
|
||||
|
||||
class DeltaOnAddition;
|
||||
---Purpose: Attribute delta on ADDITION action.
|
||||
|
||||
class DeltaOnForget;
|
||||
---Purpose: Attribute delta on FORGET action.
|
||||
|
||||
class DeltaOnResume;
|
||||
---Purpose: Attribute delta on RESUME action.
|
||||
|
||||
deferred class DeltaOnRemoval;
|
||||
---Purpose: Attribute delta on REMOVAL action.
|
||||
|
||||
deferred class DeltaOnModification;
|
||||
---Purpose: Attribute delta on MODIFICATION action.
|
||||
|
||||
class DefaultDeltaOnRemoval;
|
||||
---Purpose: Default implementation of TDF_DeltaOnRemoval.
|
||||
|
||||
class DefaultDeltaOnModification;
|
||||
---Purpose: Default implementation of TDF_DeltaOnModification.
|
||||
|
||||
|
||||
---Category: DF Basic Tools
|
||||
-- ==============================================================
|
||||
|
||||
class ChildIterator;
|
||||
---Purpose: A tool to iterate on the children of a label.
|
||||
|
||||
class ChildIDIterator;
|
||||
---Purpose: A tool to iterate on the children of a label to
|
||||
-- find attributes with an ID.
|
||||
|
||||
imported AttributeIterator;
|
||||
---Purpose: DO NOT USE THIS CLASS WITHOUT AUTHORIZATION!
|
||||
|
||||
|
||||
---Category: DF Specific Tools
|
||||
-- ==============================================================
|
||||
|
||||
class DataSet;
|
||||
---Purpose: This class is used to build a set of DF
|
||||
-- informations like labels or attributes.
|
||||
|
||||
class RelocationTable;
|
||||
---Purpose: Builds a attribute relocation dictionnary useful
|
||||
-- for copy or paste actions.
|
||||
|
||||
class Tool;
|
||||
---Purpose: This class provides general services.
|
||||
|
||||
class LabelMapHasher;
|
||||
---Purpose: A label hasher for label maps.
|
||||
|
||||
class IDFilter;
|
||||
---Purpose: This class offers filtering services around an ID list.
|
||||
|
||||
|
||||
---Category: DF Classes Instantiations
|
||||
|
@@ -23,7 +23,9 @@
|
||||
deferred class Attribute from TDF
|
||||
inherits TShared from MMgt
|
||||
|
||||
---Purpose: This abstract class, alongwith Label,
|
||||
---Purpose: A class each application has to implement. It is
|
||||
-- used to contain the application data.
|
||||
-- This abstract class, alongwith Label,
|
||||
-- is one of the cornerstones of Model Editor.
|
||||
-- The groundwork is to define the root of
|
||||
-- information. This information is to be
|
||||
|
@@ -26,6 +26,8 @@
|
||||
#include <TDF_Label.hxx>
|
||||
#include <TDF_LabelNodePtr.hxx>
|
||||
|
||||
// DO NOT USE THIS CLASS WITHOUT AUTHORIZATION!
|
||||
//
|
||||
// This class provides a way to iterates on the
|
||||
// up-to-date (current) valid attributes of a label.
|
||||
//
|
||||
|
@@ -23,7 +23,9 @@ class ClosureTool from TDF
|
||||
|
||||
---Purpose: This class provides services to build the closure
|
||||
-- of an information set.
|
||||
--
|
||||
-- This class gives services around the transitive
|
||||
-- enclosure of a set of information, starting from a
|
||||
-- list of label.
|
||||
-- You can set closure options by using IDFilter
|
||||
-- (to select or exclude specific attribute IDs) and
|
||||
-- CopyOption objects and by giving to Closure
|
||||
|
@@ -16,7 +16,7 @@
|
||||
|
||||
class CopyLabel from TDF
|
||||
|
||||
---Purpose:
|
||||
---Purpose: This class gives copy of source label hierarchy
|
||||
|
||||
uses
|
||||
|
||||
|
@@ -22,9 +22,11 @@
|
||||
|
||||
class Delta from TDF inherits TShared from MMgt
|
||||
|
||||
---Purpose: A delta set is available at <aSourceTime>. If
|
||||
-- applied, it restores the TDF_Data in the state it
|
||||
-- was at <aTargetTime>.
|
||||
---Purpose: A set of AttributeDelta for a given transaction
|
||||
-- number and reference time number.
|
||||
-- A delta set is available at <aSourceTime>. If
|
||||
-- applied, it restores the TDF_Data in the state it
|
||||
-- was at <aTargetTime>.
|
||||
|
||||
uses
|
||||
|
||||
|
@@ -21,7 +21,7 @@
|
||||
|
||||
|
||||
class LabelMapHasher from TDF
|
||||
|
||||
---Purpose: A label hasher for label maps.
|
||||
uses
|
||||
Label from TDF
|
||||
|
||||
|
@@ -15,7 +15,8 @@
|
||||
|
||||
class Reference from TDF inherits Attribute from TDF
|
||||
|
||||
---Purpose:
|
||||
---Purpose: This attribute is used to store in the framework a
|
||||
-- reference to an other label.
|
||||
|
||||
uses Attribute from TDF,
|
||||
Label from TDF,
|
||||
|
@@ -26,7 +26,8 @@ class RelocationTable from TDF
|
||||
|
||||
---Purpose: This is a relocation dictionnary between source
|
||||
-- and target labels, attributes or any
|
||||
-- transient. Note that one target value may be the
|
||||
-- transient(useful for copy or paste actions).
|
||||
-- Note that one target value may be the
|
||||
-- relocation value of more than one source object.
|
||||
--
|
||||
-- Common behaviour: it returns true and the found
|
||||
|
Reference in New Issue
Block a user