From: cascade Date: Fri, 8 Apr 2005 22:09:06 +0000 (+0000) Subject: OCC8524 Modification of cdl files in order to improve extraction of description of... X-Git-Url: http://git.dev.opencascade.org/gitweb/?a=commitdiff_plain;h=42f8beb939be8101686625d81c5a303704937562;p=occt-wok.git OCC8524 Modification of cdl files in order to improve extraction of description of classes and metods --- diff --git a/src/WOKNT/WOKNT_MixedOutput.cdl b/src/WOKNT/WOKNT_MixedOutput.cdl index 5588047..18d5660 100755 --- a/src/WOKNT/WOKNT_MixedOutput.cdl +++ b/src/WOKNT/WOKNT_MixedOutput.cdl @@ -25,7 +25,7 @@ private class MixedOutput from WOKNT inherits ShellOutput from WOKNT OpenStdOut ( me : out ) returns Integer from Standard is redefined static; ---Purpose: creates a pipe for reading a standard output of sub-process -- and returns a pipe handle. - ---Warning: returns INVALID_HANDLE_VALUE in case of failure + -- Warning: returns INVALID_HANDLE_VALUE in case of failure CloseStdOut ( me : out ) is redefined static; ---Purpose: closes write end of the 'STDOUT' pipe @@ -33,33 +33,33 @@ private class MixedOutput from WOKNT inherits ShellOutput from WOKNT OpenStdErr ( me : out ) returns Integer from Standard is virtual; ---Purpose: creates a pipe for reading a standard error output of sub-process -- and returns a pipe handle - ---Warning: this method is simply calling 'OpenStdOut' method + -- Warning: this method is simply calling 'OpenStdOut' method CloseStdErr ( me : out ) is redefined virtual; ---Purpose: closes write end of the 'STDERR' pipe - ---Warning: this method is simply calling 'CloseStdOut' method + -- Warning: this method is simply calling 'CloseStdOut' method Clear ( me : out ) is redefined virtual; ---Purpose: clears output buffer of sub-process Echo ( me : out ) returns HSequenceOfHAsciiString from TColStd is redefined static; ---Purpose: returns standard output of sub-process - ---Warning: returns NULL object if there is nothing to read + -- Warning: returns NULL object if there is nothing to read Errors ( me : out ) returns HSequenceOfHAsciiString from TColStd is redefined virtual; ---Purpose: returns standard error output of sub-process - ---Warning: this method is simply calling 'Echo' method + -- Warning: this method is simply calling 'Echo' method SyncStdOut ( me : out ) returns HSequenceOfHAsciiString from TColStd is redefined static; ---Purpose: waits for sub-process termination ( until the write end of pipe -- will be closed ). - ---Warning: write end of pipe MUST BE CLOSED by parent process immediately + -- Warning: write end of pipe MUST BE CLOSED by parent process immediately -- after creation of the child process else this method will -- NEVER return. Use ONLY 'CloseStdOut' method for this purpose. SyncStdErr ( me : out ) returns HSequenceOfHAsciiString from TColStd is redefined virtual; ---Purpose: same as 'SyncStdOut' method - ---Warning: use 'CloseStdErr' method to close write end of pipe + -- Warning: use 'CloseStdErr' method to close write end of pipe fields diff --git a/src/WOKNT/WOKNT_OutErrOutput.cdl b/src/WOKNT/WOKNT_OutErrOutput.cdl index 0a49abc..3ac8983 100755 --- a/src/WOKNT/WOKNT_OutErrOutput.cdl +++ b/src/WOKNT/WOKNT_OutErrOutput.cdl @@ -25,7 +25,7 @@ private class OutErrOutput from WOKNT inherits MixedOutput from WOKNT OpenStdErr ( me : out ) returns Integer from Standard is redefined static; ---Purpose: creates a pipe for reading a standard error output of sub-process -- and returns a pipe handle - ---Warning: returns INVALID_HANDLE_VALUE in case of failure + -- Warning: returns INVALID_HANDLE_VALUE in case of failure CloseStdErr ( me : out ) is redefined static; ---Purpose: closes write end of the 'STDERR' pipe @@ -35,12 +35,12 @@ private class OutErrOutput from WOKNT inherits MixedOutput from WOKNT Errors ( me : out ) returns HSequenceOfHAsciiString from TColStd is redefined static; ---Purpose: returns standard error output of sub-process - ---Warning: returns NULL object if there is nothing to read + -- Warning: returns NULL object if there is nothing to read SyncStdErr ( me : out ) returns HSequenceOfHAsciiString from TColStd is redefined static; ---Purpose: waits for sub-process termination ( until the write end of pipe -- will be closed ). - ---Warning: write end of pipe MUST BE CLOSED by parent process immediately + -- Warning: write end of pipe MUST BE CLOSED by parent process immediately -- after creation of the child process else this method will -- NEVER return. Use ONLY 'CloseStdErr' method for this purpose. diff --git a/src/WOKNT/WOKNT_RegExp.cdl b/src/WOKNT/WOKNT_RegExp.cdl index af5a2ae..9ae8827 100755 --- a/src/WOKNT/WOKNT_RegExp.cdl +++ b/src/WOKNT/WOKNT_RegExp.cdl @@ -36,7 +36,7 @@ class RegExp from WOKNT inherits TShared from MMgt -- if no translation necessary. It is possible to set -- syntax of the regular expression by meaning -- parameter. - ---Warning: raises if syntax of the regular expression given is incorrect + -- Warning: raises if syntax of the regular expression given is incorrect Destroy ( me : mutable ); ---Purpose: destroys all resources attached to the class instanse @@ -50,7 +50,7 @@ class RegExp from WOKNT inherits TShared from MMgt aTblLen : Integer from Standard = 0 ) raises ProgramError from Standard; ---Purpose: sets a new match pattern and possibly a new pattern syntax - ---Warning: raises if the syntax given is incorrect + -- Warning: raises if the syntax given is incorrect Search ( me; @@ -63,7 +63,7 @@ class RegExp from WOKNT inherits TShared from MMgt -- Returns an index of the match position on success. -- Returns -1 if no match was found. -- Returns -2 if error was occur. - ---Warning: raises if no search pattern was set + -- Warning: raises if no search pattern was set Match ( me; @@ -78,7 +78,7 @@ class RegExp from WOKNT inherits TShared from MMgt -- Returns the length of the string matched on success. -- Returns -1 if no match was found. -- Returns -2 if error was occur. - ---Warning: raises if no search pattern was set + -- Warning: raises if no search pattern was set fields diff --git a/src/WOKNT/WOKNT_Shell.cdl b/src/WOKNT/WOKNT_Shell.cdl index 16c2a5c..24514f2 100755 --- a/src/WOKNT/WOKNT_Shell.cdl +++ b/src/WOKNT/WOKNT_Shell.cdl @@ -94,7 +94,7 @@ class Shell from WOKNT inherits TShared from MMgt EnvironmentVariable ( me; aName : HAsciiString from TCollection ) returns HAsciiString from TCollection; ---Purpose: returns a value for a given environment variable - ---Warning: returns a null string if specified variable does not exists + -- Warning: returns a null string if specified variable does not exists Echo ( me; aStr : HAsciiString from TCollection ); ---Purpose: echoes a string diff --git a/src/WOKNT/WOKNT_ShellOutput.cdl b/src/WOKNT/WOKNT_ShellOutput.cdl index a48bc11..c385792 100755 --- a/src/WOKNT/WOKNT_ShellOutput.cdl +++ b/src/WOKNT/WOKNT_ShellOutput.cdl @@ -33,7 +33,7 @@ private deferred class ShellOutput from WOKNT inherits File from OSD OpenStdOut ( me : out ) returns Integer from Standard is deferred; ---Purpose: creates an I/O object for reading a standard output of sub-process -- and returns this object handle. - ---Warning: returns INVALID_HANDLE_VALUE in case of failure + -- Warning: returns INVALID_HANDLE_VALUE in case of failure CloseStdOut ( me : out ) is deferred; ---Purpose: closes an I/O object's handle opened by 'OpenStdOut' method @@ -41,7 +41,7 @@ private deferred class ShellOutput from WOKNT inherits File from OSD OpenStdErr ( me : out ) returns Integer from Standard is deferred; ---Purpose: creates an I/O object for reading a standard error output of sub-process -- and returns this object handle - ---Warning: returns INVALID_HANDLE_VALUE in case of failure + -- Warning: returns INVALID_HANDLE_VALUE in case of failure CloseStdErr ( me : out ) is deferred; ---Purpose: closes an I/O object's handle opened by 'OpenStdErr' method