Skip to content

Commit

Permalink
Fix ice_ids description (#1744)
Browse files Browse the repository at this point in the history
  • Loading branch information
bernardnormier authored Feb 1, 2024
1 parent 68d2fbc commit 285e1bf
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 32 deletions.
3 changes: 1 addition & 2 deletions cpp/include/Ice/Object.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 3 additions & 6 deletions cpp/include/Ice/Proxy.h
Original file line number Diff line number Diff line change
Expand Up @@ -397,8 +397,7 @@ class ICE_API ObjectPrx : public ::std::enable_shared_from_this<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.
*/
::std::vector<::std::string>
ice_ids(const ::Ice::Context& context = ::Ice::noExplicitContext)
Expand Down Expand Up @@ -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)
{
Expand Down Expand Up @@ -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);

Expand Down
3 changes: 1 addition & 2 deletions csharp/src/Ice/Object.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ public interface Object : ICloneable
/// Returns the Slice type IDs of the interfaces supported by this object.
/// </summary>
/// <param name="current">The Current object for the invocation.</param>
/// <returns>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>
/// <returns>The Slice type IDs of the interfaces supported by this object, in alphabetical order.</returns>
string[] ice_ids(Current current = null);

/// <summary>
Expand Down
16 changes: 8 additions & 8 deletions csharp/src/Ice/Proxy.cs
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,8 @@ Task<bool> ice_isAAsync(string id,
/// Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
/// </summary>
/// <param name="context">The context dictionary for the invocation.</param>
/// <returns>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.</returns>
/// <returns>The Slice type IDs of the interfaces supported by the target object, in alphabetical order.
/// </returns>
string[] ice_ids(OptionalContext context = new OptionalContext());

/// <summary>
Expand Down Expand Up @@ -248,8 +248,8 @@ Task<bool> ice_isAAsync(string id,
/// Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
/// </summary>
/// <param name="result">The asynchronous result object returned by <code>begin_ice_ids</code>.</param>
/// <returns>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.</returns>
/// <returns>The Slice type IDs of the interfaces supported by the target object, in alphabetical order.
/// </returns>
string[] end_ice_ids(AsyncResult result);

/// <summary>
Expand Down Expand Up @@ -1107,8 +1107,8 @@ private void iceI_ice_ping(Dictionary<string, string> context, OutgoingAsyncComp
/// Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
/// </summary>
/// <param name="context">The context dictionary for the invocation.</param>
/// <returns>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.</returns>
/// <returns>The Slice type IDs of the interfaces supported by the target object, in alphabetical order.
/// </returns>
public string[] ice_ids(OptionalContext context = new OptionalContext())
{
try
Expand Down Expand Up @@ -1197,8 +1197,8 @@ private AsyncResult<Callback_Object_ice_ids>
/// Returns the Slice type IDs of the interfaces supported by the target object of this proxy.
/// </summary>
/// <param name="result">The asynchronous result object returned by <code>begin_ice_ids</code>.</param>
/// <returns>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.</returns>
/// <returns>The Slice type IDs of the interfaces supported by the target object, in alphabetical order.
/// </returns>
public string[] end_ice_ids(AsyncResult result)
{
var resultI = AsyncResultI.check(result, this, _ice_ids_name);
Expand Down
3 changes: 1 addition & 2 deletions java/src/Ice/src/main/java/com/zeroc/Ice/Object.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>::Ice::Object</code>.
* @return The Slice type IDs of the interfaces supported by this object, in alphabetical order.
**/
default String[] ice_ids(Current current)
{
Expand Down
6 changes: 2 additions & 4 deletions java/src/Ice/src/main/java/com/zeroc/Ice/ObjectPrx.java
Original file line number Diff line number Diff line change
Expand Up @@ -84,17 +84,15 @@ 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 <code>::Ice::Object</code>.
* @return The Slice type IDs of the interfaces supported by the target object, in alphabetical order.
**/
String[] ice_ids();

/**
* 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 <code>::Ice::Object</code>.
* @return The Slice type IDs of the interfaces supported by the target object, in alphabetical order.
**/
String[] ice_ids(java.util.Map<String, String> context);

Expand Down
3 changes: 1 addition & 2 deletions js/src/Ice/Object.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<string[]>;

Expand Down
4 changes: 1 addition & 3 deletions matlab/lib/+Ice/ObjectPrx.m
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
3 changes: 1 addition & 2 deletions swift/src/Ice/Object.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion swift/src/Ice/Proxy.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 285e1bf

Please sign in to comment.