1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +03:00

0024784: Move documentation in CDL files to proper location

Mostly duplicated comments were removed and missing ones were moved
into dedicated class CDL files.
Some more duplicated comments were removed from CDL files.
Correction of merge
This commit is contained in:
ski
2014-05-29 16:05:47 +04:00
committed by apn
parent bdd1223f46
commit ff8178ef85
533 changed files with 1047 additions and 2921 deletions

View File

@@ -38,9 +38,6 @@ is
exception OSDError inherits Failure from Standard ;
imported Function;
---Purpose: This is in fact a pointer to a function.
-- This is not an "enumeration" but a trick to solve an omission
-- from CDL.
--- C++: alias "typedef int (* OSD_Function)(...);"
enumeration OEMType is Unavailable,SUN,DEC,SGI,NEC,MAC,PC,HP,IBM,VAX,LIN,AIX;
@@ -98,64 +95,39 @@ is
---Purpose: Allows great accuracy for error management.
-- This is private.
class Error;
---Purpose: Accurate management of OSD specific errors.
class Protection;
---Purpose: Gets and sets protection attributes of 'system , user ,
-- group, and world'.
class Path;
---Purpose: Manages independent system path translation.
deferred class FileNode;
---Purpose: A set of file/directory manipulation tools.
class Disk;
---Purpose: A set of disk oriented tools.
class File;
---Purpose: A set of file oriented tools.
class FileIterator;
---Purpose: Searches for child files in current directory.
class Directory;
---Purpose: A set of directory oriented tools
class DirectoryIterator;
---Purpose: Searches sub-directories in current directory.
class Chronometer;
---Purpose: Measures time elapsed for performance program tests.
-- Measures CPU time consumed by a method call.
class Timer;
---Purpose: Measures the effective time elapsed for a method call.
class Printer;
---Purpose: Selects a printer (used by File).
class Host;
---Purpose: Carries information about a host.
-- System version ,host name, nodename ...
class Environment;
---Purpose: Manages environment variables.
class EnvironmentIterator;
---Purpose: Get all environment variables.
class Process;
---Purpose: Process specific oriented tools
-- class Mutex is alias Mutex from Standard;
---Purpose: Mutex object to synchronize threads within one process
class SharedLibrary;
---Purpose: Provides tools to load a shared library
-- and retrieve the address of an entry point.
imported MemInfo;
imported PThread;

View File

@@ -20,7 +20,7 @@
class Directory from OSD
---Purpose: Management of directories
---Purpose: Management of directories (a set of directory oriented tools)
inherits FileNode

View File

@@ -16,7 +16,7 @@
class Disk from OSD
---Purpose: Disk management
---Purpose: Disk management (a set of disk oriented tools)
uses Error, Path, CString from Standard, AsciiString from TCollection

View File

@@ -16,7 +16,7 @@
class Error from OSD
---Purpose: Management of OSD errors
---Purpose: Accurate management of OSD specific errors.
-- Each method can be error tested with object.Failed().
-- To manage an occuring error, just use object.Perror();

View File

@@ -17,7 +17,7 @@
deferred class FileNode from OSD
---Purpose: A class for 'File' and 'Directory' grouping common
-- methods.
-- methods (file/directory manipulation tools).
-- The "file oriented" name means files or directories which are
-- in fact hard coded as files.

View File

@@ -15,6 +15,9 @@
#ifndef OSD_Function_HeaderFile
#define OSD_Function_HeaderFile
// This is in fact a pointer to a function.
// This is not an "enumeration" but a trick to solve an omission from CDL.
typedef int (* OSD_Function)(...);
#endif

View File

@@ -17,6 +17,7 @@
class Host from OSD
---Purpose: Carries information about a Host
-- System version ,host name, nodename ...
uses SysType, OEMType, Error, AsciiString from TCollection

View File

@@ -16,7 +16,7 @@
class Printer from OSD
---Purpose: Selects a printer.
---Purpose: Selects a printer (used by File).
uses Error, AsciiString from TCollection
raises ConstructionError, NullObject, OSDError

View File

@@ -19,6 +19,8 @@
class SharedLibrary from OSD
---Purpose: Interface to dynamic library loader.
-- Provides tools to load a shared library
-- and retrieve the address of an entry point.
uses LoadMode,Function
is