From f9cda97b0a733986484f92bd38f0e54a87e8ea8b Mon Sep 17 00:00:00 2001 From: prascle Date: Sat, 18 Feb 2006 17:34:15 +0000 Subject: [PATCH] PR: doxygen comments --- idl/SALOMEDS.idl | 4 ++-- src/NamingService/SALOME_NamingService.cxx | 26 ++++++++++------------ 2 files changed, 14 insertions(+), 16 deletions(-) diff --git a/idl/SALOMEDS.idl b/idl/SALOMEDS.idl index 7c0844a31..6538b93e4 100644 --- a/idl/SALOMEDS.idl +++ b/idl/SALOMEDS.idl @@ -876,14 +876,14 @@ Gets the list of open studies ListOfAttributes GetAllAttributes(); /*! Gets the study of a given %SObject. - /return The study containing the given %SObject. + \return The study containing the given %SObject. */ Study GetStudy(); /*! Gets the CORBA object by its own IOR attribute. Returns nil, if can't. - /return The CORBA object of the %SObject. + \return The CORBA object of the %SObject. */ Object GetObject(); diff --git a/src/NamingService/SALOME_NamingService.cxx b/src/NamingService/SALOME_NamingService.cxx index 0c046c9ea..783f6bae0 100644 --- a/src/NamingService/SALOME_NamingService.cxx +++ b/src/NamingService/SALOME_NamingService.cxx @@ -642,9 +642,9 @@ SALOME_NamingService::ContainerName(const Engines::MachineParameters& params) * \param params struct from which we get container name (may be * empty), number of nodes and number of processor * per node. - * /param hostname name of the host of the container, without domain names. - * /return the path under the form /Containers/hostname/containerName - * /sa ContainerName(const Engines::MachineParameters& params) + * \param hostname name of the host of the container, without domain names. + * \return the path under the form /Containers/hostname/containerName + * \sa ContainerName(const Engines::MachineParameters& params) */ // ============================================================================ @@ -664,10 +664,10 @@ string SALOME_NamingService::BuildContainerNameForNS(const char *containerName, * * Build a string representing the absolute pathname of a container in * SALOME_NamingService. - * /param params used as it is, or replaced by FactoryServer if empty. - * /param hostname name of the host of the container, without domain names. - * /return the path under the form /Containers/hostname/containerName - * /sa ContainerName(const char *containerName) + * \param params used as it is, or replaced by FactoryServer if empty. + * \param hostname name of the host of the container, without domain names. + * \return the path under the form /Containers/hostname/containerName + * \sa ContainerName(const char *containerName) */ // ============================================================================ @@ -1759,14 +1759,12 @@ _current_directory(vector& splitPath, * get a list of all the objects in the current directory, with recursion * on the subdirectories. Only the objects are listed, not the directories. * If the NamingService is out, the exception ServiceUnreachable is thrown. - * \param myList the list of objects - * \ -Function :_list_directory_recurs. - * Purpose : method to list recursively all the objects contained in the tree of absCurDirectory/relativeSubDir. - * \param myList The list that will be filled. - * \param relativeSubDir The directory from absCurDirectory in which the objects are found. - * \param absCurDirectory The directory in ABSOLUTE form. * _current_context must refer to absCurDirectory. + * + * \param myList The list that will be filled. + * \param relativeSubDir The directory relative to absCurDirectory in which + * the objects are found. + * \param absCurDirectory The current directory, absolute path */ // ============================================================================ -- 2.39.2