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

[occt.git] / src / Dico / Dico_IteratorOfDictionaryOfTransient.hxx

diff --git a/src/Dico/Dico_IteratorOfDictionaryOfTransient.hxx b/src/Dico/Dico_IteratorOfDictionaryOfTransient.hxx
index 64d80e6..20608bf 100644 (file)
--- a/src/Dico/Dico_IteratorOfDictionaryOfTransient.hxx
+++ b/src/Dico/Dico_IteratorOfDictionaryOfTransient.hxx
@@ -40,20 +40,32 @@ public:
   DEFINE_STANDARD_ALLOC
 
   
+  //! Creates an iterator which will work on all the dictionary
   Standard_EXPORT Dico_IteratorOfDictionaryOfTransient(const Handle(Dico_DictionaryOfTransient)& acell);
   
+  //! Creates an iterator which will consider only entries
+  //! which name begin by the string given as basename (subpart)
   Standard_EXPORT Dico_IteratorOfDictionaryOfTransient(const Handle(Dico_DictionaryOfTransient)& 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 Dico_IteratorOfDictionaryOfTransient(const Handle(Dico_DictionaryOfTransient)& 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(Standard_Transient)& Value() const;
   
+  //! Returns name of current entry
   Standard_EXPORT TCollection_AsciiString Name() const;
 
 
@@ -68,6 +80,7 @@ protected:
 private:
 
   
+  //! Appends a new value to the Iteration Stack
   Standard_EXPORT void AppendStack (const Handle(Dico_DictionaryOfTransient)& val);