0026595: Lost some comments in OCCT-code after cdl elimination

Recovered comments for instance classes from CDL generic classes.

src/STEPCAFControl/STEPCAFControl_DictionaryOfExternFile.hxx

@@ -42,40 +42,87 @@ class STEPCAFControl_DictionaryOfExternFile : public MMgt_TShared
 public:
 
   
+  //! Creates a Dictionary cell.
+  //! A Dictionary is always created then handled by its first cell
+  //! After creating a Dictionary, user can call methods HasItem,
+  //! Item, SetItem ... (internal cells and entries are also
+  //! defined as objects from the same class)
+  //! Also iteration can be made, by an Iterator on this Dictionary
   Standard_EXPORT STEPCAFControl_DictionaryOfExternFile();
   
+  //! Returns True if an Item is bound to a Name in the Dictionnary
+  //! <exact> : if True, commands exact matching
+  //! if False, accept completion, only if ONE AND ONLY ONE
+  //! Dictionnary Entry has <name> as beginning of its name
   Standard_EXPORT Standard_Boolean HasItem (const Standard_CString name, const Standard_Boolean exact = Standard_False) const;
   
+  //! Works as above method but accepts a String from TCollection
   Standard_EXPORT Standard_Boolean HasItem (const TCollection_AsciiString& name, const Standard_Boolean exact = Standard_True) const;
   
+  //! Returns item bound to a name in the Dictionnary
+  //! <exact> : same as for HasItem
   Standard_EXPORT const Handle(STEPCAFControl_ExternFile)& Item (const Standard_CString name, const Standard_Boolean exact = Standard_True) const;
   
+  //! Works as above method but accepts a String from TCollection
   Standard_EXPORT const Handle(STEPCAFControl_ExternFile)& Item (const TCollection_AsciiString& name, const Standard_Boolean exact = Standard_True) const;
   
+  //! Gathers HasItem and Item, in a less regular but faster way
+  //! If return is True, <anitem> is returned too, else it is not
+  //! <exact> : same as for HasItem
   Standard_EXPORT Standard_Boolean GetItem (const Standard_CString name, Handle(STEPCAFControl_ExternFile)& anitem, const Standard_Boolean exact = Standard_True) const;
   
+  //! Works as above method but accepts a String from TCollection
   Standard_EXPORT Standard_Boolean GetItem (const TCollection_AsciiString& name, Handle(STEPCAFControl_ExternFile)& anitem, const Standard_Boolean exact = Standard_True) const;
   
+  //! Binds an item to a dictionnary entry
+  //! If <name> is already known in the dictionary, its value
+  //! is changed. Else, the dictionary entry is created.
+  //! If <exact> is given False, completion is tried, it is accepted
+  //! If it gives a UNIQUE entry : hence this one will be modified
+  //! Else, new entry is created with the exact name given
   Standard_EXPORT void SetItem (const Standard_CString name, const Handle(STEPCAFControl_ExternFile)& anitem, const Standard_Boolean exact = Standard_True);
   
+  //! Works as above method but accepts a String from TCollection
   Standard_EXPORT void SetItem (const TCollection_AsciiString& name, const Handle(STEPCAFControl_ExternFile)& anitem, const Standard_Boolean exact = Standard_True);
   
+  //! Returns the Item AS AN ADDRESS which corresponds to a Name,
+  //! in order to be changed or set.
+  //! If this name is not yet recorded, the Dictionary creates it.
+  //! <isvalued> is returned True if the Item is recorded in the
+  //! Dictionary, False else, in that case the Item is reserved and
+  //! the name is noted as beeing valued now.
   Standard_EXPORT Handle(STEPCAFControl_ExternFile)& NewItem (const Standard_CString name, Standard_Boolean& isvalued, const Standard_Boolean exact = Standard_True);
   
+  //! Works as above method but accepts a String from TCollection
   Standard_EXPORT Handle(STEPCAFControl_ExternFile)& NewItem (const TCollection_AsciiString& name, Standard_Boolean& isvalued, const Standard_Boolean exact = Standard_True);
   
+  //! Removes a dictionary entry given by its name then Returns True
+  //! If the entry does not exists, Does nothing then Returns False
+  //! <exact> : as for HasItem, if completion works, the found entry
+  //! is removed (else returned value is False)
+  //! <cln> commands cleaning dictionary (to recover memory space)
+  //! For an isolated call, it is recommanded to give it at True
+  //! For a sequence of calls, rather give False, then call Clean
   Standard_EXPORT Standard_Boolean RemoveItem (const Standard_CString name, const Standard_Boolean cln = Standard_True, const Standard_Boolean exact = Standard_True);
   
+  //! Works as above method but accepts a String from TCollection
   Standard_EXPORT Standard_Boolean RemoveItem (const TCollection_AsciiString& name, const Standard_Boolean cln = Standard_True, const Standard_Boolean exact = Standard_True);
   
+  //! Deletes physically in one step the entries which were removed
+  //! (can be used for a more efficient Memory Management : first
+  //! Remove several Items (<cln> = False), then Clean the Memory)
   Standard_EXPORT void Clean();
   
+  //! Returns True if no Item is recorded
   Standard_EXPORT Standard_Boolean IsEmpty() const;
   
+  //! Clears all the Dictionary : all recorded Items are removed
   Standard_EXPORT void Clear();
   
+  //! Copies the Dictionary as a Tree, without Copying the Items
   Standard_EXPORT Handle(STEPCAFControl_DictionaryOfExternFile) Copy() const;
   
+  //! Internal routine used for completion (returns True if success)
   Standard_EXPORT Standard_Boolean Complete (Handle(STEPCAFControl_DictionaryOfExternFile)& acell) const;
 
 
@@ -92,38 +139,57 @@ protected:
 private:
 
   
+  //! Defines cell's character (internal use, to build dict. tree)
   Standard_EXPORT void SetChar (const Standard_Character car);
   
+  //! Returns True if this cell has a subcell
   Standard_EXPORT Standard_Boolean HasSub() const;
   
+  //! Returns subcell
   Standard_EXPORT Handle(STEPCAFControl_DictionaryOfExternFile) Sub() const;
   
+  //! Returns True if this cell has a next cell
   Standard_EXPORT Standard_Boolean HasNext() const;
   
+  //! Returns next cell
   Standard_EXPORT Handle(STEPCAFControl_DictionaryOfExternFile) Next() const;
   
+  //! Defines subcell
   Standard_EXPORT void SetSub (const Handle(STEPCAFControl_DictionaryOfExternFile)& acell);
   
+  //! Defines next cell
   Standard_EXPORT void SetNext (const Handle(STEPCAFControl_DictionaryOfExternFile)& acell);
   
+  //! Internal method used to get an entry from a given name
   Standard_EXPORT void SearchCell (const Standard_CString name, const Standard_Size lmax, const Standard_Character car, const Standard_Size level, Handle(STEPCAFControl_DictionaryOfExternFile)& acell, Standard_Size& reslev, Standard_Integer& stat) const;
   
+  //! Internal method used to create a new entry for a name
   Standard_EXPORT void NewCell (const Standard_CString name, const Standard_Size namlen, Handle(STEPCAFControl_DictionaryOfExternFile)& acell, const Standard_Size reslev, const Standard_Integer stat);
   
+  //! Returns True if a cell has an associated item value
   Standard_EXPORT Standard_Boolean HasIt() const;
   
+  //! Returns item value associated to a cell
   Standard_EXPORT const Handle(STEPCAFControl_ExternFile)& It() const;
   
+  //! Returns item address associated to a cell
   Standard_EXPORT Handle(STEPCAFControl_ExternFile)& ItAdr();
   
+  //! Binds an item value to a cell
   Standard_EXPORT void SetIt (const Handle(STEPCAFControl_ExternFile)& anitem);
   
+  //! Declares a cell as Valued : used by NewItem (when an Item
+  //! is created if it did not exist and is returned)
   Standard_EXPORT void DeclIt();
   
+  //! Removes item bound to a cell (cancels effect of DeclIt)
   Standard_EXPORT void RemoveIt();
   
+  //! Returns cell's character as a node feature
   Standard_EXPORT Standard_Character CellChar() const;
   
+  //! Performs Copy from an original <fromcell> to <me>
+  //! Called by Copy
   Standard_EXPORT void GetCopied (const Handle(STEPCAFControl_DictionaryOfExternFile)& fromcell);
 
   Standard_Character thecars[4];

src/STEPCAFControl/STEPCAFControl_IteratorOfDictionaryOfExternFile.hxx

@@ -39,20 +39,32 @@ public:
   DEFINE_STANDARD_ALLOC
 
   
+  //! Creates an iterator which will work on all the dictionary
   Standard_EXPORT STEPCAFControl_IteratorOfDictionaryOfExternFile(const Handle(STEPCAFControl_DictionaryOfExternFile)& acell);
   
+  //! Creates an iterator which will consider only entries
+  //! which name begin by the string given as basename (subpart)
   Standard_EXPORT STEPCAFControl_IteratorOfDictionaryOfExternFile(const Handle(STEPCAFControl_DictionaryOfExternFile)& acell, const Standard_CString basename);
   
+  //! Creates an iterator which will consider only entries
+  //! which name begin by the string given as basename (subpart)
+  //! Same as above, but basename is String instead of CString
   Standard_EXPORT STEPCAFControl_IteratorOfDictionaryOfExternFile(const Handle(STEPCAFControl_DictionaryOfExternFile)& acell, const TCollection_AsciiString& basename);
   
+  //! Allows to Start a new Iteration from beginning
   Standard_EXPORT void Start();
   
+  //! Returns True if there are more entries to return
   Standard_EXPORT Standard_Boolean More();
   
+  //! Go to the next entry
+  //! (if there is not, Value will raise an exception)
   Standard_EXPORT void Next();
   
+  //! Returns item value of current entry
   Standard_EXPORT const Handle(STEPCAFControl_ExternFile)& Value() const;
   
+  //! Returns name of current entry
   Standard_EXPORT TCollection_AsciiString Name() const;
 
 
@@ -67,6 +79,7 @@ protected:
 private:
 
   
+  //! Appends a new value to the Iteration Stack
   Standard_EXPORT void AppendStack (const Handle(STEPCAFControl_DictionaryOfExternFile)& val);
 
 

src/STEPCAFControl/STEPCAFControl_StackItemOfDictionaryOfExternFile.hxx

@@ -35,14 +35,19 @@ class STEPCAFControl_StackItemOfDictionaryOfExternFile : public MMgt_TShared
 public:
 
   
+  //! Creates a StackItem with no Previous one
   Standard_EXPORT STEPCAFControl_StackItemOfDictionaryOfExternFile();
   
+  //! Creates a StackItem with a Previous one
   Standard_EXPORT STEPCAFControl_StackItemOfDictionaryOfExternFile(const Handle(STEPCAFControl_StackItemOfDictionaryOfExternFile)& previous);
   
+  //! Returns the Previous Item (is Null if no Previous defined)
   Standard_EXPORT Handle(STEPCAFControl_StackItemOfDictionaryOfExternFile) Previous() const;
   
+  //! Returns the Dictionary Cell corresponding to an Item
   Standard_EXPORT Handle(STEPCAFControl_DictionaryOfExternFile) Value() const;
   
+  //! Sets a new Dictionary Cell as Value of an Item
   Standard_EXPORT void SetValue (const Handle(STEPCAFControl_DictionaryOfExternFile)& cval);