From: mkr Date: Thu, 7 Sep 2006 07:08:55 +0000 (+0000) Subject: Fix for bug PAL13386 : EDF PAL KERNEL DOC 276 Wrong links in documentation. X-Git-Tag: For_GUI_AutoTools~2 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=5e837a2b79660c8968c94bc701c8b06377702f50;p=modules%2Fkernel.git Fix for bug PAL13386 : EDF PAL KERNEL DOC 276 Wrong links in documentation. --- diff --git a/doc/salome/tui/Makefile.am b/doc/salome/tui/Makefile.am index 8d0902dbc..a78249a5c 100644 --- a/doc/salome/tui/Makefile.am +++ b/doc/salome/tui/Makefile.am @@ -54,6 +54,7 @@ usr_docs: cp -fr $(srcdir)/KERNEL/sources/ $(docdir)/tui/KERNEL; cp -fr $(srcdir)/KERNEL/HTML/ $(docdir)/tui/KERNEL; cp -f $(srcdir)/pythfilter.py $(docdir)/tui/KERNEL; + cp -fr $(srcdir)/KERNEL/exemple/ $(docdir)/tui/KERNEL; dev_docs: cp -fr $(srcdir)/KERNEL/* ./INPUT; \ diff --git a/idl/SALOMEDS.idl b/idl/SALOMEDS.idl index 5c270eff9..c82d3f331 100644 --- a/idl/SALOMEDS.idl +++ b/idl/SALOMEDS.idl @@ -173,7 +173,7 @@ during each working session. \param aComponentName It's a string value in the Comment Attribute of the Component, which is looked for, defining the data type of this Component. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ SComponent FindComponent (in string aComponentName); /*! @@ -186,7 +186,7 @@ during each working session. \param anObjectName String parameter defining the name of the object \return The obtained %SObject -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ SObject FindObject (in string anObjectName); @@ -234,14 +234,14 @@ during each working session. Sets the context of the %Study. \param thePath String parameter defining the context of the study. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetContext(in string thePath); /*! Gets the context of the %Study. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ string GetContext(); @@ -283,7 +283,7 @@ during each working session. \return A new %StudyBuilder. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ StudyBuilder NewBuilder() ; @@ -297,7 +297,7 @@ during each working session. Returns the attriubte, which contains the properties of this study. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ AttributeStudyProperties GetProperties(); @@ -453,7 +453,7 @@ during each working session. Creates a new %SComponent \param ComponentDataType Data type of the %SComponent which will be created. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ SComponent NewComponent(in string ComponentDataType) raises(LockProtection); @@ -476,7 +476,7 @@ during each working session. \param theFatherObject The father %SObject under which this one should be created. \return New %SObject -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ @@ -509,7 +509,7 @@ during each working session. /*! Loads a %SComponent. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception); @@ -526,7 +526,7 @@ during each working session. \param anObject The %SObject corresponding to the attribute which is looked for. \param aTypeOfAttribute Type of the attribute. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ GenericAttribute FindOrCreateAttribute(in SObject anObject, @@ -550,7 +550,7 @@ during each working session. \param anObject The %SObject corresponding to the attribute. \param aTypeOfAttribute Type of the attribute. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void RemoveAttribute(in SObject anObject, in string aTypeOfAttribute) raises(LockProtection); @@ -574,7 +574,7 @@ during each working session. Adds a directory in the %Study. \param theName String parameter defining the name of the directory. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void AddDirectory(in string theName) raises(LockProtection); @@ -601,7 +601,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin Creates a new command which can contain several different actions. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void NewCommand(); // command management @@ -611,7 +611,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void CommitCommand() raises(LockProtection); // command management @@ -623,7 +623,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin Cancels all actions declared within the command. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void AbortCommand(); // command management /*! \brief Undolimit @@ -637,7 +637,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void Undo() raises (LockProtection); @@ -647,21 +647,21 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void Redo() raises (LockProtection); /*! Returns True if at this moment there are any actions which can be canceled. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ boolean GetAvailableUndos(); /*! Returns True if at this moment there are any actions which can be redone. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ boolean GetAvailableRedos(); @@ -714,7 +714,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \param study_name String parameter defining the name of the study -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ Study NewStudy(in string study_name); @@ -725,7 +725,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \param aStudyUrl The path to the study \warning This method doesn't activate the corba objects. Only a component can do it. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception); @@ -740,7 +740,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \param theMultiFile If this parameter is True the study will be saved in several files. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ boolean Save(in Study aStudy, in boolean theMultiFile); @@ -757,7 +757,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \param aStudy The study which will be saved \param theMultiFile If this parameter is True the study will be saved in several files. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ boolean SaveAs(in URL aUrl, // if the file already exists in Study aStudy, @@ -904,7 +904,7 @@ Gets the list of open studies \param aTypeOfAttribute String value defining the type of the required attribute of the given %SObject. \return True if it finds an attribute of a definite type of the given %SObject as well as the discovered attribute. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ boolean FindAttribute(out GenericAttribute anAttribute, in string aTypeOfAttribute); @@ -918,7 +918,7 @@ Gets the list of open studies \return The list of all attributes of the given %SObject. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ ListOfAttributes GetAllAttributes(); @@ -1050,7 +1050,7 @@ Moves the iterator to the next %SComponent in the list. /*! Returns the %SComponent corresponding to the current %SComponent found by the iterator. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ SComponent Value(); @@ -1213,7 +1213,7 @@ can be called by any component and which provide the following functionality: \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files. \return A byte stream TMPFile that contains all saved data -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ @@ -1228,7 +1228,7 @@ can be called by any component and which provide the following functionality: \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files. \return A byte stream TMPFile that will contain all saved data -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile); diff --git a/idl/SALOMEDS_Attributes.idl b/idl/SALOMEDS_Attributes.idl index 461d8dbc2..d992ece00 100644 --- a/idl/SALOMEDS_Attributes.idl +++ b/idl/SALOMEDS_Attributes.idl @@ -69,13 +69,13 @@ module SALOMEDS /*! Returns the value of this attribute. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ double Value(); /*! Sets the value of this attribute. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetValue(in double value); @@ -91,13 +91,13 @@ module SALOMEDS /*! Returns the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ long Value(); /*! Sets the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetValue(in long value); }; @@ -123,7 +123,7 @@ module SALOMEDS \param value A real number added to the sequence. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void Add (in double value); /*! @@ -138,7 +138,7 @@ module SALOMEDS \param index The index of the given real number. \param value The value of another real number. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void ChangeValue(in long index, in double value); @@ -147,13 +147,13 @@ module SALOMEDS in the sequence of real numbers stored in the Attribute. \param index The index of the given real number. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ double Value(in short index); /*! Returns the length of the sequence of real numbers stored in the Attribute. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ long Length(); @@ -179,7 +179,7 @@ module SALOMEDS Adds to the end of the sequence an integer number. \param value An integer number added to the sequence. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void Add (in long value); @@ -188,7 +188,7 @@ module SALOMEDS from the sequence of integer numbers stored in the Attribute. \param index The index of the given integer number. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void Remove(in long index); @@ -204,13 +204,13 @@ module SALOMEDS in the sequence of integer numbers stored in the Attribute. \param index The index of the given integer number. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ long Value(in short index); /*! Returns the length of the sequence of integer numbers stored in the Attribute. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ long Length(); @@ -229,7 +229,7 @@ module SALOMEDS /*! Returns the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ string Value(); /*! @@ -237,7 +237,7 @@ module SALOMEDS \param value This parameter defines the value of this attribute. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetValue(in string value); }; @@ -254,14 +254,14 @@ module SALOMEDS /*! Returns the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ string Value(); /*! Sets the value of this attribute \param value This string parameter defines the value of this attribute - a description of a %SObject. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetValue(in string value); }; @@ -277,14 +277,14 @@ module SALOMEDS /*! Returns the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ string Value(); /*! Sets the value of this attribute \param value This parameter defines the value of this attribute - IOR of a %SObject. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetValue(in string value); }; @@ -300,14 +300,14 @@ module SALOMEDS /*! Returns the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ string Value(); /*! Sets the value of this attribute \param value This parameter defines the value of this attribute. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetValue(in string value); }; @@ -322,12 +322,12 @@ module SALOMEDS { /*! Returns the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ string Value(); /*! Sets the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetValue(in string value); }; @@ -342,12 +342,12 @@ module SALOMEDS { /*! Returns the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ string Value(); /*! Sets the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetValue(in string value); }; @@ -369,7 +369,7 @@ module SALOMEDS /*! Returns TRUE if the item is drawable (as it is by default) and FALSE if it isn't. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ boolean IsDrawable(); @@ -378,7 +378,7 @@ Sets the item to be drawable. \param value If the value of this boolean parameter is TRUE (default) the item will be drawable. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetDrawable(in boolean value); @@ -397,7 +397,7 @@ Sets the item to be drawable. Returns TRUE if the item is selectable (as it is by default) and FALSE if it isn't. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ boolean IsSelectable(); @@ -406,7 +406,7 @@ Sets the item to be selectable \param value If the value of this parameter is TRUE (the default) the item will be set as selectable. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetSelectable(in boolean value); @@ -425,7 +425,7 @@ Sets the item to be selectable /*! Returns TRUE if this item is expandable even when it has no children. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ boolean IsExpandable(); @@ -433,7 +433,7 @@ Sets the item to be selectable \param value If the value of this boolean parameter is TRUE, this item will be set as expandable. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetExpandable(in boolean value); @@ -482,7 +482,7 @@ Sets the item to be selectable /*! Returns TRUE if this item is open (its children are visible) and FALSE if it isn't. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ boolean IsOpened(); @@ -492,7 +492,7 @@ Sets the item to be selectable \param value If the value of this boolean parameter is TRUE this item will be set as open, and as closed if FALSE. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetOpened(in boolean value); @@ -508,7 +508,7 @@ Sets the item to be selectable /*! Returns the color of an item. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ Color TextColor(); @@ -517,7 +517,7 @@ Sets the item to be selectable \param value This parameter defines the color of the item. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetTextColor(in Color value); @@ -536,7 +536,7 @@ Sets the item to be selectable -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ Color TextHighlightColor(); @@ -544,7 +544,7 @@ Sets the item to be selectable Sets the highlight color of an item. \param value This parameter defines the highlight color of the item. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetTextHighlightColor(in Color value); @@ -564,7 +564,7 @@ Sets the item to be selectable /*! Returns the name of the icon in the format of a string. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ string GetPixMap(); @@ -572,7 +572,7 @@ Sets the item to be selectable Sets the name of the icon. \param value This string parameter defines the name of the icon. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetPixMap(in string value); @@ -585,7 +585,7 @@ Sets the item to be selectable tree whith its own structure and identifier. The quantity of such trees with different identifiers can be arbitrary. -
See also an example of usage of the methods of this interface in batchmode of %SALOME application. +
See also an example of usage of the methods of this interface in batchmode of %SALOME application. */ //========================================================================== @@ -673,7 +673,7 @@ Sets the item to be selectable /*! Deletes a tree node. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void Remove(); @@ -716,7 +716,7 @@ Sets the item to be selectable /*! Returns the value of this attribute. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ long Value(); /*! @@ -724,7 +724,7 @@ Sets the item to be selectable \param value This parameter defines the local ID which will be set. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetValue(in long value); }; @@ -740,13 +740,13 @@ Sets the item to be selectable /*! Returns the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ string Value(); /*! Sets the value of this attribute -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void SetValue(in string value); }; @@ -765,7 +765,7 @@ Sets the item to be selectable /*! Adds a %SObject to the list of %SObjects which refer to this %SObject. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void Add(in SObject anObject); @@ -776,7 +776,7 @@ Sets the item to be selectable /*! Deletes a %SObject from the list of %SObjects which refer to this %SObject. -
See also an example of this method usage in batchmode of %SALOME application. +
See also an example of this method usage in batchmode of %SALOME application. */ void Remove(in SObject anObject); @@ -787,7 +787,7 @@ Sets the item to be selectable This attribute allows to store a table of integers (indexing from 1 like in CASCADE) and string titles of this table, of each row, of each column. -
See also an example of usage of these methods in batchmode of %SALOME application. +
See also an example of usage of these methods in batchmode of %SALOME application. */ //========================================================================== @@ -946,7 +946,7 @@ Sets the item to be selectable This attribute allows to store a table of reals (indexing from 1 like in CASCADE) and string titles of this table, of each row, of each column. -
See also an example of usage of these methods in batchmode of %SALOME application. +
See also an example of usage of these methods in batchmode of %SALOME application. */ //========================================================================== @@ -1096,7 +1096,7 @@ Sets the item to be selectable This attribute allows to store a table of strings (indexing from 1 like in CASCADE) and string titles of this table, of each row, of each column. -
See also an example of usage of these methods in batchmode of %SALOME application. +
See also an example of usage of these methods in batchmode of %SALOME application. */ //========================================================================== @@ -1245,7 +1245,7 @@ Sets the item to be selectable This attribute allows to store study properties: user name, creation date, creation mode, modified flag, locked flag. -
See also an example of usage of these methods in batchmode of %SALOME application. +
See also an example of usage of these methods in batchmode of %SALOME application. */ //==========================================================================