Mon Aug 7 11:39:12 UTC 2006 Johnny Willemsen <jwillemsen@remedy.nl>

1 files changed, 25 insertions, 26 deletions

diff --git a/TAO/tao/IORManipulation/IOR.pidl b/TAO/tao/IORManipulation/IOR.pidl
index 20b010c8406..94027389de6 100644
--- a/TAO/tao/IORManipulation/IOR.pidl
+++ b/TAO/tao/IORManipulation/IOR.pidl
@@ -121,35 +121,34 @@ module TAO_IOP
   {
       typedef sequence <Object> IORList;
 
+      /// Create a new object reference by merging the profiles lists in the
+      /// supplied list of one or more object references.
       Object merge_iors (in IORList iors)
         raises (EmptyProfileList,Duplicate,Invalid_IOR);
-      // Create a new object reference by merging the profiles lists in the
-      // supplied list of one or more object references.
 
+      /// copy the profile list from "ior2" to "ior1".
+      /// Note on ordering, while the current implementation will place
+      /// the profiles from ior2 (which are not already in ior1) on the
+      /// end of the profile list in ior1, there is no guarantee this ordering
+      /// will be maintained.  For example, string_to_object or object_to_string
+      /// may reorder the profile lists.  So, if it is important to use one
+      /// profile before another then policies should be used along with tagged
+      /// components/tagged profiles.
       Object add_profiles (in Object ior1,
                            in Object ior2)
         raises (EmptyProfileList, Duplicate, Invalid_IOR);
-      // copy the profile list from "ior2" to "ior1".
-      // Note on ordering, while the current implementation will place
-      // the profiles from ior2 (which are not already in ior1) on the
-      // end of the profile list in ior1, there is no guarantee this ordering
-      // will be maintained.  For example, string_to_object or object_to_string
-      // may reorder the profile lists.  So, if it is important to use one
-      // profile before another then policies should be used along with tagged
-      // components/tagged profiles.
 
+      // Any profile in ior1 which matches at least one profile in ior2
+      // will be removed.  Returns a new object reference
       Object remove_profiles (in Object ior1,
                               in Object ior2)
         raises (Invalid_IOR, EmptyProfileList, NotFound);
-      // Any profile in ior1 which matches at least one profile in ior2
-      // will be removed.  Returns a new object reference
-
 
+      /// Allows setting of properties as defined by the @a prop object
+      /// in the @a ior list
       boolean set_property (in TAO_IOR_Property prop,
                             in Object ior)
         raises (Invalid_IOR, Duplicate);
-      // Allows setting of properties as defined by the <prop> object
-      // in the <ior> list
 
       // @@ Primary is specific to FT.. But let us have these
       // @@ operations around. Further, as we pass the property object
@@ -159,16 +158,16 @@ module TAO_IOP
       // @@ to identify a primary and some other service could use
       // @@ something else. But the actual implementation of the
       // @@ property object would take care of that.
-      boolean set_primary (in TAO_IOR_Property prop,
-                           in Object ior1,
-                           in Object ior2)
-        raises (Invalid_IOR, Duplicate, MultiProfileList, NotFound);
       // Sets the profile ior1, in the profile ior2 to be a
       // primary. If ior1 is a multi-profile IOR then the operation
       // raises the MultiProfileList exception. If ior1 is not found
       // in ior2, it raises an Invalid_IOR exception. If ior2 has a
       // primary already defined then it raises a Duplicate
       // exception.
+      boolean set_primary (in TAO_IOR_Property prop,
+                           in Object ior1,
+                           in Object ior2)
+        raises (Invalid_IOR, Duplicate, MultiProfileList, NotFound);
 
       /// If any of the IOR's within the IOGR has a primary tag, just remove
       /// it. Return zero if no primary found.
@@ -176,25 +175,25 @@ module TAO_IOP
                                   in Object ior);
 
 
+      /// Returns the ior of the primary from @a ior if it has been
+      /// set. Else returns a NotFound exception
       Object get_primary (in TAO_IOR_Property prop,
                           in Object ior)
         raises (NotFound);
-      // Returns the ior  of the primary from <ior> if it has been
-      // set. Else returns a NotFound exception
 
+      /// Returns a true or false depending on whether a primary member
+      /// has been set in @a ior
       boolean is_primary_set (in TAO_IOR_Property prop,
                               in Object ior);
-      // Returns a true or false depending on whether a primary member
-      // has been set in <ior>
 
+      /// Returns number of profiles which are in both ior1 and ior2.
       unsigned long is_in_ior(in Object ior1, in Object ior2)
         raises (NotFound);
-      // returns number of profiles which are in both ior1 and ior2.
 
+      /// This will return the number of profiles contained in the
+      /// corresponding object reference for this object.
       unsigned long get_profile_count (in Object ior)
         raises (EmptyProfileList);
-      // This will return the number of profiles contained in the
-      // corresponding object reference for this object.
   };
 };