From 285e1bfa9e6e045d1cb25a19131244f9075dc99b Mon Sep 17 00:00:00 2001 From: Bernard Normier Date: Thu, 1 Feb 2024 10:34:40 -0500 Subject: [PATCH] Fix ice_ids description (#1744) --- cpp/include/Ice/Object.h | 3 +-- cpp/include/Ice/Proxy.h | 9 +++------ csharp/src/Ice/Object.cs | 3 +-- csharp/src/Ice/Proxy.cs | 16 ++++++++-------- .../Ice/src/main/java/com/zeroc/Ice/Object.java | 3 +-- .../src/main/java/com/zeroc/Ice/ObjectPrx.java | 6 ++---- js/src/Ice/Object.d.ts | 3 +-- matlab/lib/+Ice/ObjectPrx.m | 4 +--- swift/src/Ice/Object.swift | 3 +-- swift/src/Ice/Proxy.swift | 2 +- 10 files changed, 20 insertions(+), 32 deletions(-) diff --git a/cpp/include/Ice/Object.h b/cpp/include/Ice/Object.h index e860e7bc530..79f520e7cb4 100644 --- a/cpp/include/Ice/Object.h +++ b/cpp/include/Ice/Object.h @@ -108,8 +108,7 @@ class ICE_API Object /** * Returns the Slice type IDs of the interfaces supported by this object. * @param current The Current object for the invocation. - * @return The Slice type IDs of the interfaces supported by this object, in base-to-derived - * order. The first element of the returned array is always "::Ice::Object". + * @return The Slice type IDs of the interfaces supported by this object, in alphabetical order. */ virtual std::vector< std::string> ice_ids(const Current& current) const; /// \cond INTERNAL diff --git a/cpp/include/Ice/Proxy.h b/cpp/include/Ice/Proxy.h index 4e50063e533..83fea4ae13b 100644 --- a/cpp/include/Ice/Proxy.h +++ b/cpp/include/Ice/Proxy.h @@ -397,8 +397,7 @@ class ICE_API ObjectPrx : public ::std::enable_shared_from_this /** * Returns the Slice type IDs of the interfaces supported by the target object of this proxy. * @param context The context map for the invocation. - * @return The Slice type IDs of the interfaces supported by the target object, in base-to-derived - * order. The first element of the returned array is always "::Ice::Object". + * @return The Slice type IDs of the interfaces supported by the target object, in alphabetical order. */ ::std::vector<::std::string> ice_ids(const ::Ice::Context& context = ::Ice::noExplicitContext) @@ -1854,8 +1853,7 @@ class ICE_API Object : public ::IceUtil::Shared /** * Returns the Slice type IDs of the interfaces supported by the target object of this proxy. * @param context The context map for the invocation. - * @return The Slice type IDs of the interfaces supported by the target object, in base-to-derived - * order. The first element of the returned array is always "::Ice::Object". + * @return The Slice type IDs of the interfaces supported by the target object, in alphabetical order. */ ::std::vector< ::std::string> ice_ids(const ::Ice::Context& context = ::Ice::noExplicitContext) { @@ -1927,8 +1925,7 @@ class ICE_API Object : public ::IceUtil::Shared /** * Completes an invocation of begin_ice_ids. * @param result The asynchronous result object for the invocation. - * @return The Slice type IDs of the interfaces supported by the target object, in base-to-derived - * order. The first element of the returned array is always "::Ice::Object". + * @return The Slice type IDs of the interfaces supported by the target object, in alphabetical order. */ ::std::vector< ::std::string> end_ice_ids(const ::Ice::AsyncResultPtr& result); diff --git a/csharp/src/Ice/Object.cs b/csharp/src/Ice/Object.cs index 78f776e671b..d2643c2e06c 100644 --- a/csharp/src/Ice/Object.cs +++ b/csharp/src/Ice/Object.cs @@ -46,8 +46,7 @@ public interface Object : ICloneable /// Returns the Slice type IDs of the interfaces supported by this object. /// /// The Current object for the invocation. - /// The Slice type IDs of the interfaces supported by this object, in base-to-derived - /// order. The first element of the returned array is always ::Ice::Object. + /// The Slice type IDs of the interfaces supported by this object, in alphabetical order. string[] ice_ids(Current current = null); /// diff --git a/csharp/src/Ice/Proxy.cs b/csharp/src/Ice/Proxy.cs index df093c9dec3..f73a7771152 100644 --- a/csharp/src/Ice/Proxy.cs +++ b/csharp/src/Ice/Proxy.cs @@ -205,8 +205,8 @@ Task ice_isAAsync(string id, /// Returns the Slice type IDs of the interfaces supported by the target object of this proxy. /// /// The context dictionary for the invocation. - /// The Slice type IDs of the interfaces supported by the target object, in base-to-derived - /// order. The first element of the returned array is always ::Ice::Object. + /// The Slice type IDs of the interfaces supported by the target object, in alphabetical order. + /// string[] ice_ids(OptionalContext context = new OptionalContext()); /// @@ -248,8 +248,8 @@ Task ice_isAAsync(string id, /// Returns the Slice type IDs of the interfaces supported by the target object of this proxy. /// /// The asynchronous result object returned by begin_ice_ids. - /// The Slice type IDs of the interfaces supported by the target object, in base-to-derived - /// order. The first element of the returned array is always ::Ice::Object. + /// The Slice type IDs of the interfaces supported by the target object, in alphabetical order. + /// string[] end_ice_ids(AsyncResult result); /// @@ -1107,8 +1107,8 @@ private void iceI_ice_ping(Dictionary context, OutgoingAsyncComp /// Returns the Slice type IDs of the interfaces supported by the target object of this proxy. /// /// The context dictionary for the invocation. - /// The Slice type IDs of the interfaces supported by the target object, in base-to-derived - /// order. The first element of the returned array is always ::Ice::Object. + /// The Slice type IDs of the interfaces supported by the target object, in alphabetical order. + /// public string[] ice_ids(OptionalContext context = new OptionalContext()) { try @@ -1197,8 +1197,8 @@ private AsyncResult /// Returns the Slice type IDs of the interfaces supported by the target object of this proxy. /// /// The asynchronous result object returned by begin_ice_ids. - /// The Slice type IDs of the interfaces supported by the target object, in base-to-derived - /// order. The first element of the returned array is always ::Ice::Object. + /// The Slice type IDs of the interfaces supported by the target object, in alphabetical order. + /// public string[] end_ice_ids(AsyncResult result) { var resultI = AsyncResultI.check(result, this, _ice_ids_name); diff --git a/java/src/Ice/src/main/java/com/zeroc/Ice/Object.java b/java/src/Ice/src/main/java/com/zeroc/Ice/Object.java index ec1792be3a1..12092ad9a45 100644 --- a/java/src/Ice/src/main/java/com/zeroc/Ice/Object.java +++ b/java/src/Ice/src/main/java/com/zeroc/Ice/Object.java @@ -88,8 +88,7 @@ default void ice_ping(Current current) * Returns the Slice type IDs of the interfaces supported by this object. * * @param current The {@link Current} object for the invocation. - * @return The Slice type IDs of the interfaces supported by this object, in base-to-derived - * order. The first element of the returned array is always ::Ice::Object. + * @return The Slice type IDs of the interfaces supported by this object, in alphabetical order. **/ default String[] ice_ids(Current current) { diff --git a/java/src/Ice/src/main/java/com/zeroc/Ice/ObjectPrx.java b/java/src/Ice/src/main/java/com/zeroc/Ice/ObjectPrx.java index 890654a8316..b36dd56e0d2 100644 --- a/java/src/Ice/src/main/java/com/zeroc/Ice/ObjectPrx.java +++ b/java/src/Ice/src/main/java/com/zeroc/Ice/ObjectPrx.java @@ -84,8 +84,7 @@ public interface ObjectPrx /** * Returns the Slice type IDs of the interfaces supported by the target object of this proxy. * - * @return The Slice type IDs of the interfaces supported by the target object, in base-to-derived - * order. The first element of the returned array is always ::Ice::Object. + * @return The Slice type IDs of the interfaces supported by the target object, in alphabetical order. **/ String[] ice_ids(); @@ -93,8 +92,7 @@ public interface ObjectPrx * Returns the Slice type IDs of the interfaces supported by the target object of this proxy. * * @param context The context map for the invocation. - * @return The Slice type IDs of the interfaces supported by the target object, in base-to-derived - * order. The first element of the returned array is always ::Ice::Object. + * @return The Slice type IDs of the interfaces supported by the target object, in alphabetical order. **/ String[] ice_ids(java.util.Map context); diff --git a/js/src/Ice/Object.d.ts b/js/src/Ice/Object.d.ts index 9f4faee5bbd..10804e30466 100644 --- a/js/src/Ice/Object.d.ts +++ b/js/src/Ice/Object.d.ts @@ -26,8 +26,7 @@ declare module "ice" /** * Returns the Slice type IDs of the interfaces supported by this object. * @param current The Current object for the invocation. - * @return The Slice type IDs of the interfaces supported by this object, in base-to-derived - * order. The first element of the returned array is always "::Ice::Object". + * @return The Slice type IDs of the interfaces supported by this object, in alphabetical order. */ ice_ids(current?:Current):string[]|PromiseLike; diff --git a/matlab/lib/+Ice/ObjectPrx.m b/matlab/lib/+Ice/ObjectPrx.m index ca61c262bfc..3f00b026b17 100644 --- a/matlab/lib/+Ice/ObjectPrx.m +++ b/matlab/lib/+Ice/ObjectPrx.m @@ -284,9 +284,7 @@ function ice_ping(obj, varargin) % context - Optional context map for the invocation. % % Returns (cell array of char) - The Slice type IDs of the - % interfaces supported by the target object, in base-to-derived - % order. The first element of the returned array is always - % ::Ice::Object. + % interfaces supported by the target object, in alphabetical order. is = obj.iceInvoke('ice_ids', 1, true, [], true, {}, varargin{:}); is.startEncapsulation(); diff --git a/swift/src/Ice/Object.swift b/swift/src/Ice/Object.swift index 8cea29ef82a..4cd8ce19c88 100644 --- a/swift/src/Ice/Object.swift +++ b/swift/src/Ice/Object.swift @@ -41,8 +41,7 @@ public protocol Object { /// /// - parameter current: `Ice.Current` - The Current object for the dispatch. /// - /// - returns: `[String]` The Slice type IDs of the interfaces supported by this object, in base-to-derived - /// order. The first element of the returned array is always `::Ice::Object`. + /// - returns: `[String]` The Slice type IDs of the interfaces supported by this object, in alphabetical order. func ice_ids(current: Current) throws -> [String] /// Tests whether this object supports a specific Slice interface. diff --git a/swift/src/Ice/Proxy.swift b/swift/src/Ice/Proxy.swift index 82c8e2566b2..8c6d6a180e1 100644 --- a/swift/src/Ice/Proxy.swift +++ b/swift/src/Ice/Proxy.swift @@ -522,7 +522,7 @@ public extension ObjectPrx { /// - parameter context: `Ice.Context?` - The optional context dictionary for the invocation. /// /// - returns: `Ice.StringSeq` - The Slice type IDs of the interfaces supported by the target object, - /// in base-to-derived order. The first element of the returned array is always `::Ice::Object`. + /// in alphabetical order. func ice_ids(context: Context? = nil) throws -> StringSeq { return try _impl._invoke(operation: "ice_ids", mode: .Nonmutating,