From: nri Date: Thu, 22 May 2003 08:03:53 +0000 (+0000) Subject: NRI : Add documentation. X-Git-Tag: Start-v1_1a X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=b11882e6aacf09f30a79066af8b493b064c86316;p=modules%2Fsuperv.git NRI : Add documentation. --- diff --git a/doc/Makefile.in b/doc/Makefile.in new file mode 100644 index 0000000..0190159 --- /dev/null +++ b/doc/Makefile.in @@ -0,0 +1,33 @@ + +# -* Makefile *- +# +# Author : Patrick GOLDBRONN (CEA) +# Date : 30/11/2001 +# $Header$ +# +# source path +top_srcdir=@top_srcdir@ +top_builddir=.. +srcdir=@srcdir@ +VPATH=.:@srcdir@ + +SUBDIRS=html + +doc: + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done +clean: + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done + +distclean: clean + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done + +install: + @@SETX@; for d in $(SUBDIRS); do \ + (cd $$d && $(MAKE) $@) || exit 1; \ + done diff --git a/doc/html/INPUT/HTML/AddComponent.html b/doc/html/INPUT/HTML/AddComponent.html new file mode 100644 index 0000000..b9ec0e7 --- /dev/null +++ b/doc/html/INPUT/HTML/AddComponent.html @@ -0,0 +1,46 @@ + + + + + + + + + + + + + + + + + + + + +
interface AddComponent
IDL file
Python
Adder Addition ( )
return_value = Addition ( )
double Add ( in double x, in double y, out double z )
[ return_value, z ] = Add ( x, y )
double LastResult ( )
return_value = LastResult ( )

+ + + + + + + + + + + + + + + + + + + + + + + +
interface Adder
IDL file
Python
double Add ( in double x, in double y, out double z )
[ return_value, z ] = Add ( x, y )
double AddAndCompare ( in double x, in double y, in Adder anOtherAdder, out double z )
[ return_value, z ] = AddAndCompare ( x, y, anOtherAdder )
void SetLastResult ( in double z )
SetLastResult ( z )
void LastResult ( out double z )
z = LastResult ( )

+ diff --git a/doc/html/INPUT/HTML/DivComponent.html b/doc/html/INPUT/HTML/DivComponent.html new file mode 100644 index 0000000..7e0477c --- /dev/null +++ b/doc/html/INPUT/HTML/DivComponent.html @@ -0,0 +1,14 @@ + + + + + + + + + + + + +
interface DivComponent
IDL file
Python
void Div ( in double x, in double y, out double z )
z = Div ( x, y )

+ diff --git a/doc/html/INPUT/HTML/FactorialComponent.html b/doc/html/INPUT/HTML/FactorialComponent.html new file mode 100644 index 0000000..b95e4b9 --- /dev/null +++ b/doc/html/INPUT/HTML/FactorialComponent.html @@ -0,0 +1,14 @@ + + + + + + + + + + + + +
interface FactorialComponent
IDL file
Python
long eval ( in long n )
return_value = eval ( n )

+ diff --git a/doc/html/INPUT/HTML/MulComponent.html b/doc/html/INPUT/HTML/MulComponent.html new file mode 100644 index 0000000..df34913 --- /dev/null +++ b/doc/html/INPUT/HTML/MulComponent.html @@ -0,0 +1,14 @@ + + + + + + + + + + + + +
interface MulComponent
IDL file
Python
void Mul ( in double x, in double y, out double z )
z = Mul ( x, y )

+ diff --git a/doc/html/INPUT/HTML/NPMatComponent.html b/doc/html/INPUT/HTML/NPMatComponent.html new file mode 100644 index 0000000..ae3d601 --- /dev/null +++ b/doc/html/INPUT/HTML/NPMatComponent.html @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + +
interface PCSRMat
IDL file
Python
unsigned long NbRows ( )
return_value = NbRows ( )
unsigned long NbCols ( )
return_value = NbCols ( )
void LMat ( out unsigned long start, out unsigned long end )
[ start, end ] = LMat ( )
CSRMatStruct ncsrmat ( in unsigned long start, in unsigned long end )
return_value = ncsrmat ( start, end )

+ + + + + + + + + + + + + + + + + + + + + + + +
interface NPMatComponent
IDL file
Python
void SetFileName ( in string filename )
SetFileName ( filename )
void ReadDataFromFile ( in string id_callback )
ReadDataFromFile ( id_callback )
void SaveDataToFile ( in string id_callback )
SaveDataToFile ( id_callback )
void SPGetData ( in string id_callback )
SPGetData ( id_callback )

+ diff --git a/doc/html/INPUT/HTML/NPSolveComponent.html b/doc/html/INPUT/HTML/NPSolveComponent.html new file mode 100644 index 0000000..c7f797f --- /dev/null +++ b/doc/html/INPUT/HTML/NPSolveComponent.html @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + +
interface NPSolveComponent
IDL file
Python
void Solve ( in PCSRMat A, in PVec b, out PVec x )
x = Solve ( A, b )
void SPSolve ( in PCSRMat A, in PVec b, in string id_callback )
SPSolve ( A, b, id_callback )

+ diff --git a/doc/html/INPUT/HTML/NPVecComponent.html b/doc/html/INPUT/HTML/NPVecComponent.html new file mode 100644 index 0000000..9f39247 --- /dev/null +++ b/doc/html/INPUT/HTML/NPVecComponent.html @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + +
interface PVec
IDL file
Python
unsigned long Size ( )
return_value = Size ( )
void LVec ( out unsigned long start, out unsigned long end )
[ start, end ] = LVec ( )
DoubleVec nvec ( in unsigned long start, in unsigned long end )
return_value = nvec ( start, end )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface NPVecComponent
IDL file
Python
void SetFileName ( in string filename )
SetFileName ( filename )
void ReadDataFromFile ( in string id_callback )
ReadDataFromFile ( id_callback )
void SaveDataToFile ( in string id_callback )
SaveDataToFile ( id_callback )
void SPGetData ( in string id_callback )
SPGetData ( id_callback )
void SPPutData ( in PVec vec, in string id_callback )
SPPutData ( vec, id_callback )

+ diff --git a/doc/html/INPUT/HTML/SUPERV.html b/doc/html/INPUT/HTML/SUPERV.html new file mode 100644 index 0000000..22cd5ee --- /dev/null +++ b/doc/html/INPUT/HTML/SUPERV.html @@ -0,0 +1,678 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface SuperG
IDL file
Python
Graph Graph ( in string aGraph )
return_value = Graph ( aGraph )
Graph GraphE ( in string aGraph )
return_value = GraphE ( aGraph )
Value StringValue ( in string aString )
return_value = StringValue ( aString )
Value AnyValue ( in any anAny )
return_value = AnyValue ( anAny )
Graph getGraph ( in string ior )
return_value = getGraph ( ior )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface CNode
IDL file
Python
string Name ( )
return_value = Name ( )
Service Service ( )
return_value = Service ( )
KindOfNode Kind ( )
return_value = Kind ( )
SDate CreationDate ( )
return_value = CreationDate ( )
SDate LastUpdateDate ( )
return_value = LastUpdateDate ( )
string Version ( )
return_value = Version ( )
string Author ( )
return_value = Author ( )
string Comment ( )
return_value = Comment ( )
boolean SetName ( in string aNewName )
return_value = SetName ( aNewName )
boolean SetAuthor ( in string anAuthor )
return_value = SetAuthor ( anAuthor )
boolean SetComment ( in string aComment )
return_value = SetComment ( aComment )
Port Port ( in string aParameterName )
return_value = Port ( aParameterName )
Port Input ( in string InputParameterName, in Value aValue )
return_value = Input ( InputParameterName, aValue )
ListOfPorts Ports ( )
return_value = Ports ( )
ListOfLinks Links ( )
return_value = Links ( )
boolean IsGraph ( )
return_value = IsGraph ( )
boolean IsComputing ( )
return_value = IsComputing ( )
boolean IsFactory ( )
return_value = IsFactory ( )
boolean IsInLine ( )
return_value = IsInLine ( )
boolean IsGOTO ( )
return_value = IsGOTO ( )
boolean IsLoop ( )
return_value = IsLoop ( )
boolean IsEndLoop ( )
return_value = IsEndLoop ( )
boolean IsSwitch ( )
return_value = IsSwitch ( )
boolean IsEndSwitch ( )
return_value = IsEndSwitch ( )
long SubGraph ( )
return_value = SubGraph ( )
long Thread ( )
return_value = Thread ( )
boolean IsWaiting ( )
return_value = IsWaiting ( )
boolean IsReady ( )
return_value = IsReady ( )
boolean IsRunning ( )
return_value = IsRunning ( )
boolean IsDone ( )
return_value = IsDone ( )
boolean IsSuspended ( )
return_value = IsSuspended ( )
GraphState State ( )
return_value = State ( )
boolean ReadyW ( )
return_value = ReadyW ( )
boolean RunningW ( )
return_value = RunningW ( )
boolean DoneW ( )
return_value = DoneW ( )
boolean SuspendedW ( )
return_value = SuspendedW ( )
boolean Kill ( )
return_value = Kill ( )
boolean KillDone ( )
return_value = KillDone ( )
boolean Stop ( )
return_value = Stop ( )
boolean Suspend ( )
return_value = Suspend ( )
boolean SuspendDone ( )
return_value = SuspendDone ( )
boolean Resume ( )
return_value = Resume ( )
boolean ReRun ( )
return_value = ReRun ( )
boolean ReRunAt ( in string aNodeName )
return_value = ReRunAt ( aNodeName )
boolean ReStart ( )
return_value = ReStart ( )
boolean ReStartAt ( in string aNodeName )
return_value = ReStartAt ( aNodeName )
AutomatonState AutoState ( )
return_value = AutoState ( )
ControlState Control ( )
return_value = Control ( )
void ControlClear ( )
ControlClear ( )
boolean ContainerKill ( )
return_value = ContainerKill ( )
void Coords ( in long X, in long Y )
Coords ( X, Y )
long X ( )
return_value = X ( )
long Y ( )
return_value = Y ( )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface FNode
IDL file
Python
string GetComponentName ( )
return_value = GetComponentName ( )
string GetInterfaceName ( )
return_value = GetInterfaceName ( )
string GetContainer ( )
return_value = GetContainer ( )
boolean SetComponentName ( in string aComponentName )
return_value = SetComponentName ( aComponentName )
boolean SetInterfaceName ( in string anInterfaceName )
return_value = SetInterfaceName ( anInterfaceName )
boolean SetContainer ( in string aContainer )
return_value = SetContainer ( aContainer )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface INode
IDL file
Python
void SetPyFunction ( in string FuncName, in ListOfStrings aPyInitFunction )
SetPyFunction ( FuncName, aPyInitFunction )
ListOfStrings PyFunction ( )
return_value = PyFunction ( )
string PyFuncName ( )
return_value = PyFuncName ( )
Port InPort ( in string aParameterName, in string aParameterType )
return_value = InPort ( aParameterName, aParameterType )
Port OutPort ( in string aParameterName, in string aParameterType )
return_value = OutPort ( aParameterName, aParameterType )

+ + + + + + + + + + + + + + + +
interface GNode
IDL file
Python
boolean SetCoupled ( in string anInLineNode )
return_value = SetCoupled ( anInLineNode )
INode Coupled ( )
return_value = Coupled ( )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface LNode
IDL file
Python
void SetPyInit ( in string MoreName, in ListOfStrings aPyMoreFunction )
SetPyInit ( MoreName, aPyMoreFunction )
ListOfStrings PyInit ( )
return_value = PyInit ( )
string PyInitName ( )
return_value = PyInitName ( )
void SetPyMore ( in string MoreName, in ListOfStrings aPyMoreFunction )
SetPyMore ( MoreName, aPyMoreFunction )
ListOfStrings PyMore ( )
return_value = PyMore ( )
string PyMoreName ( )
return_value = PyMoreName ( )
void SetPyNext ( in string NextName, in ListOfStrings aPyNextFunction )
SetPyNext ( NextName, aPyNextFunction )
ListOfStrings PyNext ( )
return_value = PyNext ( )
string PyNextName ( )
return_value = PyNextName ( )

+ + + + + + + +
interface ELNode
IDL file
Python

+ + + + + + + +
interface SNode
IDL file
Python

+ + + + + + + +
interface ESNode
IDL file
Python

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface Graph
IDL file
Python
CNode CNode ( in Service aService )
return_value = CNode ( aService )
FNode FNode ( in string aComponentName, in string anInterfaceName, in Service aService )
return_value = FNode ( aComponentName, anInterfaceName, aService )
INode INode ( in string FuncName, in ListOfStrings aPythonFunction )
return_value = INode ( FuncName, aPythonFunction )
GNode GNode ( in string FuncName, in ListOfStrings aPythonFunction, in string anINode )
return_value = GNode ( FuncName, aPythonFunction, anINode )
LNode LNode ( in string InitName, in ListOfStrings InitFunction, in string MoreName, in ListOfStrings MoreFunction, in string NextName, in ListOfStrings NextFunction, out INode anEndOfLoop )
[ return_value, anEndOfLoop ] = LNode ( InitName, InitFunction, MoreName, MoreFunction, NextName, NextFunction )
SNode SNode ( in string FuncName, in ListOfStrings aPythonFunction, out INode anEndOfSwitch )
[ return_value, anEndOfSwitch ] = SNode ( FuncName, aPythonFunction )
Component ComponentRef ( in string aComputerContainer, in string aComponentName )
return_value = ComponentRef ( aComputerContainer, aComponentName )
Link Link ( in Port OutputPort, in Port InputPort )
return_value = Link ( OutputPort, InputPort )
boolean Import ( in string anXmlFile )
return_value = Import ( anXmlFile )
boolean Export ( in string anXmlFile )
return_value = Export ( anXmlFile )
boolean IsReadOnly ( )
return_value = IsReadOnly ( )
boolean Run ( )
return_value = Run ( )
boolean EventNoW ( out CNode aNode, out GraphEvent anEvent, out GraphState aState )
[ return_value, aNode, anEvent, aState ] = EventNoW ( )
boolean Event ( out CNode aNode, out GraphEvent anEvent, out GraphState aState )
[ return_value, aNode, anEvent, aState ] = Event ( )
boolean EventW ( out CNode aNode, out GraphEvent anEvent, out GraphState aState )
[ return_value, aNode, anEvent, aState ] = EventW ( )
long LevelMax ( )
return_value = LevelMax ( )
ListOfNodes LevelNodes ( in long aLevel )
return_value = LevelNodes ( aLevel )
long ThreadsMax ( )
return_value = ThreadsMax ( )
long GraphsNumber ( )
return_value = GraphsNumber ( )
long Threads ( )
return_value = Threads ( )
long SuspendedThreads ( )
return_value = SuspendedThreads ( )
boolean IsValid ( )
return_value = IsValid ( )
boolean IsExecutable ( )
return_value = IsExecutable ( )
boolean IsDataFlow ( )
return_value = IsDataFlow ( )
boolean IsEditing ( )
return_value = IsEditing ( )
boolean IsExecuting ( )
return_value = IsExecuting ( )
long LastLevelDone ( )
return_value = LastLevelDone ( )
boolean Start ( )
return_value = Start ( )
Graph Copy ( )
return_value = Copy ( )
boolean Merge ( in Graph aGraph )
return_value = Merge ( aGraph )
ListOfNodes Nodes ( )
return_value = Nodes ( )
ListOfLinks GLinks ( )
return_value = GLinks ( )
string getIOR ( )
return_value = getIOR ( )
ListOfGraphs Graphs ( )
return_value = Graphs ( )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface Link
IDL file
Python
Port OutPort ( )
return_value = OutPort ( )
Port InPort ( )
return_value = InPort ( )
long CoordsSize ( )
return_value = CoordsSize ( )
boolean AddCoord ( in long index, in long X, in long Y )
return_value = AddCoord ( index, X, Y )
boolean ChangeCoord ( in long index, in long X, in long Y )
return_value = ChangeCoord ( index, X, Y )
boolean RemoveCoord ( in long index )
return_value = RemoveCoord ( index )
boolean Coords ( in long index, out long X, out long Y )
[ return_value, X, Y ] = Coords ( index )

+ + + + + + + + + + + + + + + + + + + + + + + +
interface Value
IDL file
Python
string ToString ( )
return_value = ToString ( )
any ToAny ( )
return_value = ToAny ( )
boolean IsIOR ( )
return_value = IsIOR ( )
string ComponentDataType ( )
return_value = ComponentDataType ( )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface Port
IDL file
Python
boolean Input ( in Value aValue )
return_value = Input ( aValue )
CNode Node ( )
return_value = Node ( )
string Name ( )
return_value = Name ( )
string Type ( )
return_value = Type ( )
Link Link ( )
return_value = Link ( )
ListOfLinks Links ( )
return_value = Links ( )
boolean IsInput ( )
return_value = IsInput ( )
boolean HasInput ( )
return_value = HasInput ( )
boolean IsLinked ( )
return_value = IsLinked ( )
KindOfPort Kind ( )
return_value = Kind ( )
boolean IsParam ( )
return_value = IsParam ( )
boolean IsGate ( )
return_value = IsGate ( )
boolean IsInLine ( )
return_value = IsInLine ( )
boolean IsLoop ( )
return_value = IsLoop ( )
boolean IsSwitch ( )
return_value = IsSwitch ( )
boolean IsEndSwitch ( )
return_value = IsEndSwitch ( )
GraphState State ( )
return_value = State ( )
boolean IsDone ( )
return_value = IsDone ( )

+ diff --git a/doc/html/INPUT/HTML/SubComponent.html b/doc/html/INPUT/HTML/SubComponent.html new file mode 100644 index 0000000..ecbbcfc --- /dev/null +++ b/doc/html/INPUT/HTML/SubComponent.html @@ -0,0 +1,14 @@ + + + + + + + + + + + + +
interface SubComponent
IDL file
Python
void Sub ( in double x, in double y, out double z )
z = Sub ( x, y )

+ diff --git a/doc/html/INPUT/HTML/SyrComponent.html b/doc/html/INPUT/HTML/SyrComponent.html new file mode 100644 index 0000000..c94b3c5 --- /dev/null +++ b/doc/html/INPUT/HTML/SyrComponent.html @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface SyrComponent
IDL file
Python
long C_ISEVEN ( in long anInteger )
return_value = C_ISEVEN ( anInteger )
long C_ISONE ( in long anOddInteger )
return_value = C_ISONE ( anOddInteger )
long C_M3 ( in long anOddInteger )
return_value = C_M3 ( anOddInteger )
long C_M3P1 ( in long anOddInteger )
return_value = C_M3P1 ( anOddInteger )
long C_DIV2 ( in long anEvenInteger )
return_value = C_DIV2 ( anEvenInteger )
long C_INCR ( in long aCount )
return_value = C_INCR ( aCount )
long C_MIN ( in long aMinVal, in long anInteger )
return_value = C_MIN ( aMinVal, anInteger )
long C_MAX ( in long aMaxVal, in long anInteger )
return_value = C_MAX ( aMaxVal, anInteger )
ListOfSyr C_LISTOFSYR ( )
return_value = C_LISTOFSYR ( )
ListOfSyr C_AVERAGE ( in ListOfSyr aListOfSyr, in long anInteger, in long aCount, out double anAverage )
[ return_value, anAverage ] = C_AVERAGE ( aListOfSyr, anInteger, aCount )
Syr Init ( in long anOddInteger )
return_value = Init ( anOddInteger )

+ + + + + + + + + + + + + + + +
interface ListOfSyr
IDL file
Python
SeqOfSyr GetSeqOfSyr ( )
return_value = GetSeqOfSyr ( )
void SetSeqOfSyr ( in SeqOfSyr aSeqOfSyr )
SetSeqOfSyr ( aSeqOfSyr )

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface Syr
IDL file
Python
long Initial ( )
return_value = Initial ( )
long Current ( )
return_value = Current ( )
long IsEven ( )
return_value = IsEven ( )
long IsOne ( )
return_value = IsOne ( )
long Count ( )
return_value = Count ( )
void M3p1 ( )
M3p1 ( )
void Div2 ( )
Div2 ( )
void Incr ( )
Incr ( )

+ diff --git a/doc/html/INPUT/HTML/SyrControlComponent.html b/doc/html/INPUT/HTML/SyrControlComponent.html new file mode 100644 index 0000000..8f39a3d --- /dev/null +++ b/doc/html/INPUT/HTML/SyrControlComponent.html @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
interface SyrControlComponent
IDL file
Python
void L_OneEven ( in long ValOne, in long ValEven, out long Finished, out long Incr, out long Even, out long Odd )
[ Finished, Incr, Even, Odd ] = L_OneEven ( ValOne, ValEven )
void C_NotOneIsEven ( out long ValOne, out long ValEven )
[ ValOne, ValEven ] = C_NotOneIsEven ( )
void LOOPN ( in long InLoop, in long NN, in long KK, in long min, in long max, out long OutLoop, out long N, out long K )
[ OutLoop, N, K ] = LOOPN ( InLoop, NN, KK, min, max )
void WHILENOTONE ( in long N, out long OutLoop )
OutLoop = WHILENOTONE ( N )
void IFNOTEVEN ( in long N, out long Odd, out long Even )
[ Odd, Even ] = IFNOTEVEN ( N )
void LOOPi ( in long InLoop, in long ii, out long OutLoop, out long i )
[ OutLoop, i ] = LOOPi ( InLoop, ii )
void WHILEEVEN ( in long N, out long OutLoop )
OutLoop = WHILEEVEN ( N )

+ diff --git a/doc/html/INPUT/doxyfile b/doc/html/INPUT/doxyfile new file mode 100755 index 0000000..3c5125f --- /dev/null +++ b/doc/html/INPUT/doxyfile @@ -0,0 +1,200 @@ +# Doxyfile 1.3-rc1 + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "SALOME PRO - SUPERV - v.1.1a" +PROJECT_NUMBER = id#1.0 +OUTPUT_DIRECTORY = ../ +OUTPUT_LANGUAGE = English +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = NO +ALWAYS_DETAILED_SEC = YES +INLINE_INHERITED_MEMB = YES +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +INTERNAL_DOCS = YES +CASE_SENSE_NAMES = YES +SHORT_NAMES = NO +HIDE_SCOPE_NAMES = NO +VERBATIM_HEADERS = YES +SHOW_INCLUDE_FILES = YES +JAVADOC_AUTOBRIEF = YES +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = NO +INHERIT_DOCS = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = NO +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 5 +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ALIASES = +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 25 +OPTIMIZE_OUTPUT_FOR_C = YES +OPTIMIZE_OUTPUT_JAVA = YES +SHOW_USED_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = log.txt +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ../../../share/salome/idl/SUPERV.idl +FILE_PATTERNS = +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = sources/ +INPUT_FILTER = +FILTER_SOURCE_FILES = YES +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = sources/myheader.html +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_SCHEMA = +XML_DTD = +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = NO +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HIDE_UNDOC_RELATIONS = NO +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = NO +TEMPLATE_RELATIONS = YES +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DOT_IMAGE_FORMAT = jpg +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1200 +GENERATE_LEGEND = NO +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO +CGI_NAME = search.cgi +CGI_URL = +DOC_URL = +DOC_ABSPATH = +BIN_ABSPATH = /usr/local/bin/ +EXT_DOC_PATHS = diff --git a/doc/html/INPUT/sources/Application-About.png b/doc/html/INPUT/sources/Application-About.png new file mode 100755 index 0000000..80e0bcb Binary files /dev/null and b/doc/html/INPUT/sources/Application-About.png differ diff --git a/doc/html/INPUT/sources/Application-About1.jpg b/doc/html/INPUT/sources/Application-About1.jpg new file mode 100755 index 0000000..b8f2cfb Binary files /dev/null and b/doc/html/INPUT/sources/Application-About1.jpg differ diff --git a/doc/html/INPUT/sources/application.gif b/doc/html/INPUT/sources/application.gif new file mode 100644 index 0000000..10da488 Binary files /dev/null and b/doc/html/INPUT/sources/application.gif differ diff --git a/doc/html/INPUT/sources/application.jpg b/doc/html/INPUT/sources/application.jpg new file mode 100755 index 0000000..6d3b6a0 Binary files /dev/null and b/doc/html/INPUT/sources/application.jpg differ diff --git a/doc/html/INPUT/sources/bg_salomepro.gif b/doc/html/INPUT/sources/bg_salomepro.gif new file mode 100755 index 0000000..677b704 Binary files /dev/null and b/doc/html/INPUT/sources/bg_salomepro.gif differ diff --git a/doc/html/INPUT/sources/doxygen.css b/doc/html/INPUT/sources/doxygen.css new file mode 100755 index 0000000..6e2c772 --- /dev/null +++ b/doc/html/INPUT/sources/doxygen.css @@ -0,0 +1,49 @@ +H1 { text-align: center; } +CAPTION { font-weight: bold } +A.qindex {} +A.qindexRef {} +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } +A:hover { text-decoration: none; background-color: lightblue } +DL.el { margin-left: -1cm } +DIV.fragment { width: 100%; border: none; background-color: #CCCCCC } +DIV.ah { background-color: #CCCCCC; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: lightblue; font-weight: bold; } +TD.mdname1 { background-color: lightblue; font-weight: bold; color: #602020; } +TD.mdname { background-color: lightblue; font-weight: bold; color: #602020; width: 600px; } +DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold } +DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller } +BODY { background: url(sources/bg_salomepro.gif) } +TD.indexkey { + background-color: #CCCCCC; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +TD.indexvalue { + background-color: #CCCCCC; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +span.keyword { color: #008000 } +span.keywordtype { color: #604020 } +span.keywordflow { color: #e08000 } +span.comment { color: #800000 } +span.preprocessor { color: #806020 } +span.stringliteral { color: #002080 } +span.charliteral { color: #008080 } diff --git a/doc/html/INPUT/sources/logocorp.gif b/doc/html/INPUT/sources/logocorp.gif new file mode 100755 index 0000000..7697e08 Binary files /dev/null and b/doc/html/INPUT/sources/logocorp.gif differ diff --git a/doc/html/INPUT/sources/myheader.html b/doc/html/INPUT/sources/myheader.html new file mode 100755 index 0000000..83ca543 --- /dev/null +++ b/doc/html/INPUT/sources/myheader.html @@ -0,0 +1,24 @@ + + + + + + Main Page + + + +  +
+ + + + + + +
+
+
+ + + + diff --git a/doc/html/INPUT/sources/occ.gif b/doc/html/INPUT/sources/occ.gif new file mode 100755 index 0000000..ce017c8 Binary files /dev/null and b/doc/html/INPUT/sources/occ.gif differ diff --git a/doc/html/Makefile.in b/doc/html/Makefile.in new file mode 100644 index 0000000..6b636a2 --- /dev/null +++ b/doc/html/Makefile.in @@ -0,0 +1,38 @@ +# -* Makefile *- +# +# Author : Vasily Rusyaev (Open Cascade NN) +# Date : 13/02/2003 +# $Header: +# +# source path +top_srcdir=@top_srcdir@ +top_builddir=../.. +srcdir=@srcdir@ +VPATH=.:@srcdir@ +doxygen=@DOXYGEN@ + +@COMMENCE@ + +doc: + cp -fr $(srcdir)/INPUT ./; \ + cd INPUT; \ + sed 's|../../../share/salome|../$(top_srcdir)|' doxyfile > doxyfile1; \ + mv -f doxyfile1 doxyfile; \ + $(doxygen) ./doxyfile; \ + cd ..; \ + cp -f $(srcdir)/INPUT/sources/doxygen.css ./html/doxygen.css + cp -fr $(srcdir)/INPUT/sources/ html/ + cp -fr $(srcdir)/INPUT/exemple/ html/ + cp -fr $(srcdir)/INPUT/HTML/ html/ + +clean: + rm -rf html + +distclean: clean + rm -rf INPUT + +install: + cp -rf html $(docdir) + +uninstall: + rm -rf $(docdir)/html