]> 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)
src/CPPExt/CPPExt.cxx
src/CPPExt/CPPExt.hxx
src/CPPExt/CPPExt_Define.hxx
src/CPPExt/CPPExt_Enum.cxx
src/CPPExt/CPPExt_Exception.cxx
src/CPPExt/CPPExt_MPV.cxx
src/CPPExt/CPPExt_Package.cxx
src/CPPExt/CPPExt_PersistentCSFDB.cxx
src/CPPExt/CPPExt_Storable.cxx
src/CPPExt/CPPExt_Template.edl
src/CPPExt/CPPExt_Transient.cxx

index aaf2f6af1709e2499b75193f4a2a047559003fde..1197c5517a2da306b8f9200ea43d2866e2be3bc7 100755 (executable)
@@ -333,6 +333,7 @@ void CPP_BuildMethod(const Handle(MS_MetaSchema)& aMeta,
 
   // here we process all the common attributes of methods
   //
+  api->AddVariable(VMethodComment, m->Comment()->ToCString());
   api->AddVariable(VMethodName,methodName->ToCString());
   api->AddVariable(VVirtual,"");
   
@@ -841,6 +842,7 @@ void CPP_ClassTypeMgt(const Handle(MS_MetaSchema)& ,
   api->AddVariable(VInherits,str->ToCString());
   api->AddVariable(VAncestors,str1->ToCString());
   api->AddVariable(VClass,aClass->FullName()->ToCString());
+  //api->AddVariable(VClassComment,aClass->Comment()->ToCString());
 
   api->Apply(var,"TypeMgt");
 }
index 2d57e9bd870ca592774a5026cf5f66df3b174436..eed8d534a3024bacf3c4c81bedf5919da47468d4 100755 (executable)
@@ -143,6 +143,7 @@ void CPP_BuildMethod(const Handle(MS_MetaSchema)& aMeta,
 // EDL variables
 //
 Standard_CString VClass              = "%Class",
+                 VClassComment       = "%ClassComment", 
                  VTICIncludes        = "%TICIncludes",
                 VInherits           = "%Inherits",
                 VTICPublicmets      = "%TICPublicmets",
@@ -159,6 +160,7 @@ Standard_CString VClass              = "%Class",
                  VVirtual            = "%Virtual",
                  VReturn             = "%Return",
                  VAnd                = "%And",
+                 VMethodComment      = "%MethodComment",
                  VMethodName         = "%MethodName",
                  VArgument           = "%Arguments",
                  VMetSpec            = "%MetSpec",
index 1c0eb68c7fdd6b9996085670afbb64612216434a..17c8d6a405b81983aa9f0ddebebfbd38767b7023 100755 (executable)
@@ -2,6 +2,7 @@
 #define _CPPExt_Define_HeaderFile
 
 extern Standard_CString VClass,
+                 VClassComment,
                  VTICIncludes,
                 VInherits,
                 VTICPublicmets,
@@ -19,6 +20,7 @@ extern Standard_CString VClass,
                  VVirtual,
                  VReturn,
                  VAnd,
+                 VMethodComment,
                  VMethodName,
                  VArgument,
                  VMetSpec,
index 0573827f9b24ec266f0991d4e3e990dda1fa6a5b..eb34b3014d3f170001ae40c4f2c287ddf803b3d6 100755 (executable)
@@ -16,7 +16,6 @@
 
 // Extraction of a transient class (inst or std)
 //
-//void CPP_Enum(const Handle(MS_MetaSchema)& aMeta,
 void CPP_Enum(const Handle(MS_MetaSchema)& ,
                        const Handle(EDL_API)& api,
                        const Handle(MS_Enum)& anEnum,
@@ -33,6 +32,7 @@ void CPP_Enum(const Handle(MS_MetaSchema)& ,
   
   api->AddVariable(VNb,result->ToCString());
   api->AddVariable(VClass,anEnum->FullName()->ToCString());
+  api->AddVariable("%EnumComment",anEnum->Comment()->ToCString());
   
   result->Clear();
 
index 335269bbf68b0896450a1e31d0b3a13dd5efd561..8b1717c0974d5a9399392f4eb13b4b0f879ce30f 100755 (executable)
@@ -58,6 +58,8 @@ void CPP_ExceptionDerivated(const Handle(MS_MetaSchema)& aMeta,
   Handle(TCollection_HAsciiString)        result    = new TCollection_HAsciiString;
 
   api->AddVariable(VClass,aClass->FullName()->ToCString());
+  api->AddVariable(VClassComment,aClass->Comment()->ToCString());
+
   api->Apply(VSupplement,"ExceptionMethod");
   
   supplement->Append(api->GetVariableValue(VSupplement));
index dcda72a55feeafbb4e544214169e82a6fd803d24..723a716eb522c8cc81b8c1308f5e9873f57361da 100755 (executable)
@@ -1,3 +1,5 @@
+
+
 // CLE
 //    
 // 10/1995
@@ -61,8 +63,8 @@ void CPP_MPVDerivated(const Handle(MS_MetaSchema)& aMeta,
   //
   if (theClass.IsNull()) return;
 
-  api->AddVariable(VClass,aClass->FullName()->ToCString());
-
+  //api->AddVariable(VClass,aClass->FullName()->ToCString());
+  api->AddVariable(VClassComment,aClass->Comment()->ToCString());
   api->AddVariable(VSuffix,"hxx");
   
   for (i = 1; i <= inclist->Length(); i++) {
@@ -140,6 +142,7 @@ void CPP_MPVDerivated(const Handle(MS_MetaSchema)& aMeta,
   }
 
   api->AddVariable(VClass,aClass->FullName()->ToCString());
+  //api->AddVariable(VClassComment,aClass->Comment()->ToCString());
 
   api->Apply(VoutClass,"MPVIxx");
 
@@ -172,7 +175,6 @@ void CPP_MPVClass(const Handle(MS_MetaSchema)& aMeta,
     Standard_Boolean                        HasInlineMethod = Standard_False,
                                             HasDestructor   = Standard_False;
 
-
     api->AddVariable(VTICIncludes,"");
     api->AddVariable(VTICPublicfriends,"");
     api->AddVariable(VTICProtectedfields,"");
@@ -196,6 +198,7 @@ void CPP_MPVClass(const Handle(MS_MetaSchema)& aMeta,
     }
 
     api->AddVariable(VClass,theClass->FullName()->ToCString());
+    api->AddVariable(VClassComment,theClass->Comment()->ToCString());
 
     for (i = 1; i <= theClass->GetFriendsNames()->Length(); i++) {
       publics->AssignCat("friend ");
@@ -377,3 +380,4 @@ void CPP_MPVClass(const Handle(MS_MetaSchema)& aMeta,
   }
 }
 
+
index 934bab4006a55f632f80996e6ee3c14340b09b30..8ce5713b9a17713be4b91580cf3b85bdb564f191 100755 (executable)
@@ -1,3 +1,4 @@
+
 // CLE
 //    
 // 10/1995
@@ -45,7 +46,6 @@
 //   the supplement variable is used for non inline methods generated 
 //   by the extractor like destructor (added to .ixx ans _0.cxx
 //
-//void CPP_PackageDerivated(const Handle(MS_MetaSchema)& aMeta,
 void CPP_PackageDerivated(const Handle(MS_MetaSchema)& ,
                            const Handle(EDL_API)& api,
                            const Handle(MS_Package)& aPackage,                     
@@ -58,6 +58,7 @@ void CPP_PackageDerivated(const Handle(MS_MetaSchema)& ,
   Handle(TCollection_HAsciiString)        result    = new TCollection_HAsciiString;
 
   api->AddVariable(VClass,aPackage->Name()->ToCString());
+  //api->AddVariable(VClassComment,aPackage->Comment()->ToCString());
   api->AddVariable(VSuffix,"hxx");
   
   for (i = 1; i <= inclist->Length(); i++) {
@@ -113,6 +114,7 @@ void CPP_PackageDerivated(const Handle(MS_MetaSchema)& ,
 
   CPP_WriteFile(api,aFileName,VoutClass); 
   
+
   outfile->Append(aFileName);
 }
 
@@ -155,6 +157,7 @@ void CPP_Package(const Handle(MS_MetaSchema)& aMeta,
     api->AddVariable(VTICPrivatemets,"");
     api->AddVariable(VMethods,"");
     api->AddVariable(VClass,aPackage->FullName()->ToCString());
+    api->AddVariable(VClassComment,aPackage->Comment()->ToCString());
     api->AddVariable(VTICSuppMethod,"");
 
     // extraction of the methods
@@ -239,6 +242,9 @@ void CPP_Package(const Handle(MS_MetaSchema)& aMeta,
     }
 
     for (i = 1; i <= packClass->Length(); i++) {
+      //Documentation
+
+
       // Declaration incomplete et
       //
       Handle(TCollection_HAsciiString) name = MS::BuildFullName(aPackage->Name(),packClass->Value(i));
index 3bcc6c443e8fb9ec995f2e59900905643627628b..5ec3d66be8809c9a0fadde46e204c94a1b4d08c9 100755 (executable)
@@ -57,6 +57,7 @@ void CPP_BuildVArrayDeclarationCSFDB(const Handle(MS_MetaSchema)&,
 
     if (aGen->IsSameString(MS::GetVArrayRootName())) {
       api->AddVariable(VDName,aClass->FullName()->ToCString());
+      api->AddVariable(VClassComment,aClass->Comment()->ToCString());
       api->AddVariable(VDValue,anInst->InstTypes()->Value(1)->ToCString());
       api->Apply(VDValue,"VArrayDeclareCSFDB");
       Result->AssignCat(api->GetVariableValue(VDValue));
@@ -191,6 +192,7 @@ void CPP_PersistentDerivatedCSFDB(const Handle(MS_MetaSchema)& aMeta,
   if (theClass.IsNull()) return;
 
   api->AddVariable(VClass,aClass->FullName()->ToCString());
+  //api->AddVariable(VClassComment,aClass->Comment()->ToCString());
 
   api->AddVariable(VSuffix,"hxx");
   
@@ -339,6 +341,7 @@ void CPP_PersistentClassCSFDB(const Handle(MS_MetaSchema)& aMeta,
     api->AddVariable(VTICSuppMethod,"");
 
     api->AddVariable(VClass,theClass->FullName()->ToCString());
+    api->AddVariable(VClassComment,theClass->Comment()->ToCString());
     api->AddVariable(VInherits,theClass->GetInheritsNames()->Value(1)->ToCString());
 
     for (i = 1; i <= theClass->GetFriendsNames()->Length(); i++) {
index 99f078064a93613740e87e60a02221e9c2371d66..2dcadee34d80d4bf3a60f6b19ed6f2424a995ef1 100755 (executable)
@@ -178,6 +178,7 @@ void CPP_StorableDerivated(const Handle(MS_MetaSchema)& aMeta,
   if (theClass.IsNull()) return;
 
   api->AddVariable(VClass,aClass->FullName()->ToCString());
+  //api->AddVariable(VClassComment,aClass->Comment()->ToCString());
 
   api->AddVariable(VSuffix,"hxx");
   
@@ -330,6 +331,8 @@ void CPP_StorableClass(const Handle(MS_MetaSchema)& aMeta,
     }
 
     api->AddVariable(VClass,theClass->FullName()->ToCString());
+    api->AddVariable(VClassComment,theClass->Comment()->ToCString());
+
     api->AddVariable("%NameField",theClass->FullName()->ToCString());
 
     for (i = 1; i <= theClass->GetFriendsNames()->Length(); i++) {
index 0454495187a1a5ae1f4b9aedcf99816841b73e96..3db1e0a868c28ef24a93c97f5413d3457e3ecaaf 100755 (executable)
@@ -109,7 +109,8 @@ $#endif
 -- extraction of a transient class
 -- ===============================
 
-@template TransientInstClass (%Class,
+@template TransientInstClass (%ClassComment,
+                             %Class,
                               %TICIncludes,
                               %Inherits,
                               %TICPublicmets,
@@ -157,6 +158,7 @@ $#endif
 $
 $%TICIncludes
 $
+$%ClassComment
 $class %Class : public %Inherits {
 $
 $public:
@@ -257,7 +259,8 @@ $%Methods
 -- extraction of a normal c++ class
 -- ================================
 
-@template MPVClass (%Class,
+@template MPVClass (%ClassComment,
+                    %Class,
                     %TICIncludes,
                     %Inherits,
                     %TICPublicmets,
@@ -304,6 +307,7 @@ $#ifndef _Standard_Macro_HeaderFile
 $#include <Standard_Macro.hxx>
 $#endif
 $
+$%ClassComment
 $class %Class %Inherits {
 $
 $public:
@@ -393,7 +397,8 @@ $%Methods
 -- extraction of a storable class
 -- ==============================
 
-@template StorableClass(%Class,
+@template StorableClass(%ClassComment,
+                        %Class,
                         %TICIncludes,
                         %Inherits,
                         %TICPublicmets,
@@ -442,6 +447,7 @@ $#endif
 $
 $Standard_EXPORT Handle_Standard_Type& %Class_Type_();
 $
+$%ClassComment
 $class %Class %Inherits {
 $
 $public:
@@ -541,7 +547,7 @@ $%Methods
 -- Enum extraction
 -- ===============
 
-@template EnumHXX(%Class,%Values) is
+@template EnumHXX(%EnumComment,%Class,%Values) is
 $// File generated by CPPExt (Enum)
 $//
 $//                     Copyright (C) 1991 - 2000 by  
@@ -566,6 +572,7 @@ $
 $#ifndef _%Class_HeaderFile
 $#define _%Class_HeaderFile
 $
+$%EnumComment
 $enum %Class { 
 $ %Values
 $};
@@ -859,11 +866,14 @@ $%Class::%Class(%Arguments)\^
 $%Virtual %RetSpec %Return%And %Class::%MethodName(%Arguments) %MetSpec\^
 @end;
 
-@template MethodTemplateDec(%Method) is
+@template MethodTemplateDec(%MethodComment,%Method) is
+$
+$%MethodComment
 $Standard_EXPORT %Method;
 @end;
 
-@template MethodTemplateDecInlineWNT(%Method) is
+@template MethodTemplateDecInlineWNT(%MethodComment,%Method) is
+$%MethodComment
 $%Method;
 @end;
 
index f661341e6be9f9a71dc3081ae110283ffe41f1a8..0e59d9c8264748b1c978d5e8038d4ac50762001e 100755 (executable)
@@ -82,6 +82,7 @@ void CPP_TransientDerivated(const Handle(MS_MetaSchema)& aMeta,
   if (theClass.IsNull()) return;
 
   api->AddVariable(VClass,aClass->FullName()->ToCString());
+  //api->AddVariable(VClassComment,aClass->Comment()->ToCString());
 
   api->AddVariable(VSuffix,"hxx");
   
@@ -219,6 +220,8 @@ void CPP_TransientClass(const Handle(MS_MetaSchema)& aMeta,
     api->AddVariable(VTICSuppMethod,"");
 
     api->AddVariable(VClass,theClass->FullName()->ToCString());
+    api->AddVariable(VClassComment,theClass->Comment()->ToCString());
+
     api->AddVariable(VInherits,theClass->GetInheritsNames()->Value(1)->ToCString());
 
     for (i = 1; i <= theClass->GetFriendsNames()->Length(); i++) {