]> OCCT Git - occt-wok.git/commitdiff
OCC9462 Changing approach at Reference Documentation production cdl,hxx,cxx,tcl,edl...
authorcascade <cascade@opencascade.com>
Fri, 9 Sep 2005 21:47:22 +0000 (21:47 +0000)
committercascade <cascade@opencascade.com>
Fri, 9 Sep 2005 21:47:22 +0000 (21:47 +0000)
16 files changed:
src/MS/MS_Class.cdl
src/MS/MS_Class.cxx
src/MS/MS_Enum.cdl
src/MS/MS_Enum.cxx
src/MS/MS_GenClass.cdl
src/MS/MS_GenClass.cxx
src/MS/MS_InstClass.cdl
src/MS/MS_InstClass.cxx
src/MS/MS_Method.cdl
src/MS/MS_Method.cxx
src/MS/MS_Package.cdl
src/MS/MS_Package.cxx
src/MS/MS_Schema.cdl
src/MS/MS_Schema.cxx
src/MS/MS_StdClass.cdl
src/MS/MS_StdClass.cxx

index 53bfca0a424eaa6f0945214e54ac5beeeb4010d4..3f52eda134b1fd23fd7d2efa0ca5496f0d789883 100755 (executable)
@@ -115,7 +115,13 @@ is
        
     IsStorable(me : mutable)
        returns Boolean from Standard;
-       
+    
+    Comment(me)
+         returns HAsciiString from TCollection;
+    
+    SetComment(me : mutable; aComment : HAsciiString from TCollection);
+
+        
 fields
 
     myIncomplete : Boolean                 from Standard;
@@ -129,8 +135,9 @@ fields
     myFriendMets : HSequenceOfHAsciiString from TColStd;
     myFriends    : HSequenceOfHAsciiString from TColStd;
     myMother     : HAsciiString            from TCollection;
-    myNestingClass : HAsciiString            from TCollection;
-    
+    myNestingClass : HAsciiString          from TCollection;
+    myComment    : HAsciiString            from TCollection;   -- Comment to class declaration 
+
 end Class from MS;
 
 
index 5fc6b16e08a4ac2dd23063e5d8fdf17b1570ac2a..e98f4eaa9d9ffc79a647ce38fbc7861da8682291 100755 (executable)
@@ -21,6 +21,7 @@ MS_Class::MS_Class(const Handle(TCollection_HAsciiString)& aName,
     myFields         = new MS_HSequenceOfField;
     myFriendMets     = new TColStd_HSequenceOfHAsciiString;
     myFriends        = new TColStd_HSequenceOfHAsciiString;
+    myComment        = new TCollection_HAsciiString("");
     myIncomplete     = Standard_True;
     myPrivate        = Standard_False;
     myDeferred       = Standard_False;
@@ -55,7 +56,8 @@ MS_Class::MS_Class(const Handle(TCollection_HAsciiString)& aName,
     myFields         = new MS_HSequenceOfField;
     myFriendMets     = new TColStd_HSequenceOfHAsciiString;
     myFriends        = new TColStd_HSequenceOfHAsciiString;
-    
+    myComment        = new TCollection_HAsciiString("");
+
     FullName(aFullName);
   }
   else {
@@ -83,7 +85,6 @@ Standard_Boolean MS_Class::Private() const
   return myPrivate;
 }
 
-//void MS_Class::Check(const Handle(TCollection_HAsciiString)& aName, const Handle(TCollection_HAsciiString)& aPackage) const 
 void MS_Class::Check(const Handle(TCollection_HAsciiString)& , const Handle(TCollection_HAsciiString)& ) const 
 {
 }
@@ -408,4 +409,16 @@ Standard_Boolean MS_Class::IsStorable()
   else return Standard_False;
 }
 
+Handle(TCollection_HAsciiString)  MS_Class::Comment() const
+{
+//  const Handle(TCollection_HAsciiString)& startComment  = new TCollection_HAsciiString("///");
+
+//  if (myComment->IsSameString(startComment)) myComment->Clear();
+  return myComment;
+}
+
+void MS_Class::SetComment(const Handle(TCollection_HAsciiString)& aComment)
+{
+  myComment->AssignCat(aComment);
+}
 
index 2040696def8bd95ffdc06fce743203d8477c435c..6d99cd2b5b5fdfe0e5b3014a82056877e98d62bc 100755 (executable)
@@ -28,9 +28,15 @@ is
        
     Check(me);
 
+    Comment(me)
+         returns HAsciiString from TCollection;
+    
+    SetComment(me : mutable; aComment : HAsciiString from TCollection);
+
 fields
 
     myEnums        : HSequenceOfHAsciiString from TColStd;
+    myEnumComment      : HAsciiString from TCollection;   -- Comment to enumeration declaration 
 
 end Enum from MS;
 
index 37def79a758d904518ece466e76edb2b2290acb6..e096af1d349fe6b27fc23824c300dcc9cb0ab3b2 100755 (executable)
@@ -8,7 +8,8 @@ MS_Enum::MS_Enum(const Handle(TCollection_HAsciiString)& aName,
                 const Handle(TCollection_HAsciiString)& aContainer, 
                 const Standard_Boolean aPrivate) : MS_NatType(aName,aPackage,aContainer,aPrivate) 
 {
-  myEnums = new TColStd_HSequenceOfHAsciiString;
+  myEnums   = new TColStd_HSequenceOfHAsciiString;
+  myEnumComment = new TCollection_HAsciiString("");
 }
 
 void MS_Enum::Enum(const Handle(TCollection_HAsciiString)& anEnum)
@@ -43,3 +44,12 @@ void MS_Enum::Check() const
   }
 }
 
+Handle(TCollection_HAsciiString)  MS_Enum::Comment() const
+{
+  return myEnumComment;
+}
+
+void MS_Enum::SetComment(const Handle(TCollection_HAsciiString)& aComment)
+{
+  myEnumComment->AssignCat(aComment);
+}
index f43e8a9f3db6e735f37e34be4ae69f7562255af7..35a48ba90f42c04bc3ea6aabe58c7f5effd66790 100755 (executable)
@@ -53,6 +53,7 @@ is
     GenType(me: mutable; aItem: GenType from MS);
     GenTypes(me)
        returns mutable HSequenceOfGenType from MS;
+
        
 fields
 
@@ -60,6 +61,8 @@ fields
     myNestStd  : HSequenceOfHAsciiString from TColStd;
     myNestIns  : HSequenceOfHAsciiString from TColStd;
     myNested   : HSequenceOfHAsciiString from TColStd;
+    myComment  : HAsciiString            from TCollection;   -- Comment to class declaration 
+
     
 end GenClass from MS;
 
index 02ca37f3bff66661e11279f5bdd848868547cde3..9822a58a50389ac030ea74805b7105c73cf00ac4 100755 (executable)
@@ -11,6 +11,7 @@ MS_GenClass::MS_GenClass(const Handle(TCollection_HAsciiString)& aName, const Ha
   myNestStd  = new TColStd_HSequenceOfHAsciiString;
   myNestIns  = new TColStd_HSequenceOfHAsciiString;
   myNested   = new TColStd_HSequenceOfHAsciiString;
+  myComment  = new TCollection_HAsciiString("");
 }
 
 MS_GenClass::MS_GenClass(const Handle(TCollection_HAsciiString)& aName, 
@@ -23,6 +24,8 @@ MS_GenClass::MS_GenClass(const Handle(TCollection_HAsciiString)& aName,
   myNestStd  = new TColStd_HSequenceOfHAsciiString;
   myNestIns  = new TColStd_HSequenceOfHAsciiString;
   myNested   = new TColStd_HSequenceOfHAsciiString;
+  myComment  = new TCollection_HAsciiString("");
+
   Private(aPrivate);
   Deferred(aDeferred);
   Incomplete(aInComplete);
@@ -213,3 +216,6 @@ void MS_GenClass::CheckNested() const
 }
 
 
+
+
+
index 796167c522cba65fd5a806770062b47712f0cb73..60291d51ca0269032151dfeb8294d463e4816405 100755 (executable)
@@ -96,7 +96,8 @@ is
     ---Purpose: test or set the flag when the instantiation has been done
 
     Initialize(me : mutable);
-    ---Purpose: Prepare a instclass for a second instantiates pass 
+    ---Purpose: Prepare a instclass for a second instantiates pass
       
 fields
 
@@ -107,6 +108,7 @@ fields
      myNestStd       : HSequenceOfHAsciiString from TColStd;
      myNestIns       : HSequenceOfHAsciiString from TColStd;
      myNestNeu       : HSequenceOfHAsciiString from TColStd;
+     myComment       : HAsciiString            from TCollection; -- Comment to class declaration 
      myInstFlag      : Boolean from Standard;
      
 end InstClass from MS;
index e6e5a98ce9ec15dffd6afa11e88b84ab82eca2fb..d3a805fb7817bd33e72a410b78425c25abc7c8dd 100755 (executable)
@@ -14,6 +14,7 @@ MS_InstClass::MS_InstClass(const Handle(TCollection_HAsciiString)& aName,
   myGenType(new TColStd_HSequenceOfHAsciiString),myNestStd(new TColStd_HSequenceOfHAsciiString),
   myNestIns(new TColStd_HSequenceOfHAsciiString),myNestNeu(new TColStd_HSequenceOfHAsciiString),myInstFlag(Standard_False)
 {
+    myComment        = new TCollection_HAsciiString(""); 
 }
 
 MS_InstClass::MS_InstClass(const Handle(TCollection_HAsciiString)& aName, 
@@ -26,10 +27,9 @@ MS_InstClass::MS_InstClass(const Handle(TCollection_HAsciiString)& aName,
   myGenType(new TColStd_HSequenceOfHAsciiString),myNestStd(new TColStd_HSequenceOfHAsciiString),
   myNestIns(new TColStd_HSequenceOfHAsciiString),myNestNeu(new TColStd_HSequenceOfHAsciiString),myInstFlag(Standard_False)
 {
+    myComment        = new TCollection_HAsciiString(""); 
 }
 
-//void MS_InstClass::Validity(const Handle(TCollection_HAsciiString)& aName, 
-//                         const Handle(TCollection_HAsciiString)& aPackage) const 
 void MS_InstClass::Validity(const Handle(TCollection_HAsciiString)& , 
                            const Handle(TCollection_HAsciiString)& ) const 
 {
@@ -434,3 +434,4 @@ void MS_InstClass::Initialize()
     myInstType->Append(myBasicInsType->Value(i));
   }
 }
+
index 61cd0d4b640884a3440903bba1219caa7db6c724..2d01f445223e3493b52ba6f37240c979613a9e85 100755 (executable)
@@ -55,6 +55,10 @@ is
        returns HAsciiString from TCollection;
        
     SetAliasType(me : mutable; aType : Boolean from Standard);
+
+    Comment(me)
+         returns HAsciiString from TCollection;
+    SetComment(me : mutable; aComment : HAsciiString from TCollection);
     
     IsOperator(me) 
        returns Boolean from Standard;
@@ -83,6 +87,7 @@ fields
     myReturns   : Param from MS;                   -- return parameter
     myRaises    : HSequenceOfHAsciiString from TColStd;        -- list of exceptions it raises
     myAlias     : HAsciiString from TCollection;   -- alias method of me
+    myComment   : HAsciiString from TCollection;   -- Comment to method 
     
 end Method from MS;
 
index f3e2b0d70cd06f9089c55e14098a8a4fd317ffe7..633e359e182087939e3554ed5470c6ac8a87955e 100755 (executable)
@@ -9,8 +9,9 @@
 #define MET_INLINE   0x10
 #define MET_OPERATOR 0x20
 #define MET_FUNCCALL 0x40
+#define MET_COMMENT  0x05
 
-MS_Method::MS_Method(const Handle(TCollection_HAsciiString)& aName) : MS_Common(aName),myAttribute(0),myRaises(new TColStd_HSequenceOfHAsciiString)
+MS_Method::MS_Method(const Handle(TCollection_HAsciiString)& aName) : MS_Common(aName),myAttribute(0),myRaises(new TColStd_HSequenceOfHAsciiString),myComment(new TCollection_HAsciiString(""))
 {
 }
 
@@ -325,6 +326,18 @@ void MS_Method::SetAliasType(const Standard_Boolean aType)
   }  
 }
 
+Handle(TCollection_HAsciiString)  MS_Method::Comment() const
+{
+  //const Handle(TCollection_HAsciiString)& startComment  = new TCollection_HAsciiString("///");
+  //if (myComment->IsSameString(startComment)) myComment->Clear();
+  return myComment;
+}
+
+void MS_Method::SetComment(const Handle(TCollection_HAsciiString)& aComment)
+{
+  myComment->AssignCat(aComment);
+}
+
 Standard_Boolean MS_Method::IsOperator() const 
 {
   if (myAttribute & MET_OPERATOR) {
index 7736fa1b32954f06d808119be923edcb5f56be98..a4c7bdf2610da96e1362359da3a7f5b7b23e761f 100755 (executable)
@@ -77,6 +77,10 @@ is
     Method(me: mutable; aMethod: ExternMet from MS);
     Methods(me) 
        returns mutable HSequenceOfExternMet from MS;
+    Comment(me)
+         returns HAsciiString from TCollection;
+    SetComment(me : mutable; aComment : HAsciiString from TCollection);
+
        
 fields
 
@@ -89,7 +93,8 @@ fields
     myImports  : HSequenceOfHAsciiString from TColStd;
     myPrims    : HSequenceOfHAsciiString from TColStd;
     
-    myMethods : HSequenceOfExternMet from MS;
+    myMethods  : HSequenceOfExternMet from MS;
+    myPackComment  : HAsciiString from TCollection;   -- Comment to Package declaration 
 
 end Package from MS;
 
index 8dc622e8aee58248fc080bd2e41a07d4b5a6ba1f..91c9f37c34218c821119be9c877608344d595d32 100755 (executable)
@@ -13,6 +13,8 @@ MS_Package::MS_Package(const Handle(TCollection_HAsciiString)& aPackage) : MS_Gl
   myImports  = new TColStd_HSequenceOfHAsciiString;
   myPrims    = new TColStd_HSequenceOfHAsciiString;
 
+  myPackComment  = new TCollection_HAsciiString("");
+
   myMethods  = new MS_HSequenceOfExternMet;
 
   myUses->Append(Name());
@@ -287,4 +289,19 @@ Handle(MS_HSequenceOfExternMet) MS_Package::Methods() const
   return myMethods;
 }
 
+Handle(TCollection_HAsciiString)  MS_Package::Comment() const
+{
+  //Handle(TCollection_HAsciiString) aRetComment = myComment;
+  //myComment->Clear();
+  //return aRetComment;
+  //const Handle(TCollection_HAsciiString)& startComment  = new TCollection_HAsciiString("///");
+  //if (myPackComment->IsSameString(startComment)) myPackComment->Clear();
+  return myPackComment;
+}
+
+void MS_Package::SetComment(const Handle(TCollection_HAsciiString)& aComment)
+{
+  myPackComment -> AssignCat(aComment);
+}
+
 
index 89e9a4dec1f5f5127f1b65faf94d2a9ac6f7c181..5f0d31d702a97c4f959ced18737ba2545ace6d1d 100755 (executable)
@@ -23,11 +23,16 @@ is
        
     Class(me : mutable; aClass : HAsciiString from TCollection);
     GetClasses(me) returns HSequenceOfHAsciiString from TColStd;
+  
+    Comment(me)  returns HAsciiString from TCollection;
+    SetComment(me : mutable; aComment : HAsciiString from TCollection);
+
     
 fields
 
     myPackages    : HSequenceOfHAsciiString from TColStd;
     myClasses     : HSequenceOfHAsciiString from TColStd;
-    
+    mySchemaComment  : HAsciiString from TCollection;   -- Comment to Schema declaration
+   
 end Schema from MS;
 
index b9a1927fbbfaa7edf702d2c597400c3daa274af5..79a2f7ea6b351f606ffd8ee3b9b7fd1590f46e6d 100755 (executable)
@@ -5,6 +5,7 @@ MS_Schema::MS_Schema(const Handle(TCollection_HAsciiString)& aSchema) : MS_Globa
 {
   myPackages = new TColStd_HSequenceOfHAsciiString;
   myClasses  = new TColStd_HSequenceOfHAsciiString;
+  mySchemaComment  = new TCollection_HAsciiString("");
 }
 
 void MS_Schema::Package(const Handle(TCollection_HAsciiString)& aPackage)
@@ -26,5 +27,16 @@ Handle(TColStd_HSequenceOfHAsciiString) MS_Schema::GetClasses() const
 {
   return myClasses;
 }
+Handle(TCollection_HAsciiString)  MS_Schema::Comment() const
+{
+//  const Handle(TCollection_HAsciiString)& startComment  = new TCollection_HAsciiString("///");
+//  if (mySchemaComment->IsSameString(startComment)) mySchemaComment->Clear();
+  return mySchemaComment;
+}
+
+void MS_Schema::SetComment(const Handle(TCollection_HAsciiString)& aComment)
+{
+  mySchemaComment->AssignCat(aComment);
+}
 
 
index 797735da3931ee7b685d6fab149b865103be7bb5..99ea02b776a8fcd66a4f07849b0ece698e9c81f5 100755 (executable)
@@ -35,10 +35,17 @@ is
        returns Boolean from Standard;
     ---Purpose: if <me> has not been instantiated return True
     --          Because <me> may be defined in a generic class.
-    
+
+    --Comment(me)
+    --    returns HAsciiString from TCollection;
+
+    --SetComment(me : mutable; aComment : HAsciiString from TCollection);
+
 fields
-    myInstClass      : InstClass                 from MS;
-    myNestingState   : Boolean from Standard;   -- True if <me> is a generic stdclass (not created by insttostd - see InstClass)
+    myInstClass      : InstClass     from MS;
+    myNestingState   : Boolean       from Standard;      -- True if <me> is a generic stdclass (not created by insttostd - see InstClass)
+    myComment        : HAsciiString  from TCollection;   -- Comment to class declaration
     
 end StdClass from MS;
 
index c691d5d21c8402e386af3effb558a1471853fbdb..f0cc0809760efffbd46e54637071aca55108d123 100755 (executable)
@@ -7,6 +7,7 @@ MS_StdClass::MS_StdClass(const Handle(TCollection_HAsciiString)& aName,
                         const Handle(TCollection_HAsciiString)& aPackage) :
                          MS_Class(aName,aPackage), myNestingState(Standard_False)
 {
+    myComment        = new TCollection_HAsciiString("");
 }
 
 MS_StdClass::MS_StdClass(const Handle(TCollection_HAsciiString)& aName, 
@@ -17,10 +18,9 @@ MS_StdClass::MS_StdClass(const Handle(TCollection_HAsciiString)& aName,
                         const Standard_Boolean aInComplete) 
 : MS_Class(aName,aPackage,Mother,aPrivate,aDeferred,aInComplete), myNestingState(Standard_False)
 {
+    myComment        = new TCollection_HAsciiString("");
 }
 
-//void MS_StdClass::Validity(const Handle(TCollection_HAsciiString)& aName, 
-//                        const Handle(TCollection_HAsciiString)& aPackage) const 
 void MS_StdClass::Validity(const Handle(TCollection_HAsciiString)& , 
                           const Handle(TCollection_HAsciiString)& ) const 
 {
@@ -45,3 +45,14 @@ Standard_Boolean MS_StdClass::IsGeneric() const
 {
   return myNestingState;
 }
+
+//Handle(TCollection_HAsciiString)  MS_StdClass::Comment() const
+//{
+//  return myComment;
+//}
+
+//void MS_StdClass::SetComment(const Handle(TCollection_HAsciiString)& aComment)
+//{
+//  myComment->AssignCat(aComment);
+//}
+