zeroc-ice 3.7.0 → 3.7.5

data/ext/ice/cpp/include/generated/Ice/ConnectionF.h

@@ -1,13 +1,8 @@
-// **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// Copyright (c) ZeroC, Inc. All rights reserved.
 //
-// This copy of Ice is licensed to you under the terms described in the
-// ICE_LICENSE file included in this distribution.
 //
-// **********************************************************************
-//
-// Ice version 3.7.0
+// Ice version 3.7.5
 //
 // <auto-generated>
 //
@@ -37,10 +32,10 @@
 #   if ICE_INT_VERSION / 100 != 307
 #       error Ice version mismatch!
 #   endif
-#   if ICE_INT_VERSION % 100 > 50
+#   if ICE_INT_VERSION % 100 >= 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 5
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -66,11 +61,14 @@ class Connection;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
@@ -81,6 +79,7 @@ using WSConnectionInfoPtr = ::std::shared_ptr<WSConnectionInfo>;
 using ConnectionPtr = ::std::shared_ptr<Connection>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -88,23 +87,31 @@ namespace Ice
 {
 
 class ConnectionInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::ConnectionInfo*);
-typedef ::IceInternal::Handle< ::Ice::ConnectionInfo> ConnectionInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(ConnectionInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< ConnectionInfo> ConnectionInfoPtr;
 
 class WSConnectionInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::WSConnectionInfo*);
-typedef ::IceInternal::Handle< ::Ice::WSConnectionInfo> WSConnectionInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(WSConnectionInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< WSConnectionInfo> WSConnectionInfoPtr;
 
 class Connection;
-ICE_API ::Ice::LocalObject* upCast(::Ice::Connection*);
-typedef ::IceInternal::Handle< ::Ice::Connection> ConnectionPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(Connection*);
+/// \endcond
+typedef ::IceInternal::Handle< Connection> ConnectionPtr;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/Ice/Current.h

@@ -1,13 +1,8 @@
-// **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// Copyright (c) ZeroC, Inc. All rights reserved.
 //
-// This copy of Ice is licensed to you under the terms described in the
-// ICE_LICENSE file included in this distribution.
 //
-// **********************************************************************
-//
-// Ice version 3.7.0
+// Ice version 3.7.5
 //
 // <auto-generated>
 //
@@ -41,10 +36,10 @@
 #   if ICE_INT_VERSION / 100 != 307
 #       error Ice version mismatch!
 #   endif
-#   if ICE_INT_VERSION % 100 > 50
+#   if ICE_INT_VERSION % 100 >= 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 5
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -64,27 +59,108 @@
 namespace Ice
 {
 
+/**
+ * A request context. <code>Context</code> is used to transmit metadata about a
+ * request from the server to the client, such as Quality-of-Service
+ * (QoS) parameters. Each operation on the client has a <code>Context</code> as
+ * its implicit final parameter.
+ */
 using Context = ::std::map<::std::string, ::std::string>;
 
+/**
+ * Determines the retry behavior an invocation in case of a (potentially) recoverable error.
+ */
 enum class OperationMode : unsigned char
 {
+    /**
+     * Ordinary operations have <code>Normal</code> mode.  These operations
+     * modify object state; invoking such an operation twice in a row
+     * has different semantics than invoking it once. The Ice run time
+     * guarantees that it will not violate at-most-once semantics for
+     * <code>Normal</code> operations.
+     */
     Normal,
+    /**
+     * Operations that use the Slice <code>nonmutating</code> keyword must not
+     * modify object state. For C++, nonmutating operations generate
+     * <code>const</code> member functions in the skeleton. In addition, the Ice
+     * run time will attempt to transparently recover from certain
+     * run-time errors by re-issuing a failed request and propagate
+     * the failure to the application only if the second attempt
+     * fails.
+     *
+     * <p class="Deprecated"><code>Nonmutating</code> is deprecated; Use the
+     * <code>idempotent</code> keyword instead. For C++, to retain the mapping
+     * of <code>nonmutating</code> operations to C++ <code>const</code>
+     * member functions, use the <code>\["cpp:const"]</code> metadata
+     * directive.
+     */
     Nonmutating,
+    /**
+     * Operations that use the Slice <code>idempotent</code> keyword can modify
+     * object state, but invoking an operation twice in a row must
+     * result in the same object state as invoking it once.  For
+     * example, <code>x = 1</code> is an idempotent statement,
+     * whereas <code>x += 1</code> is not. For idempotent
+     * operations, the Ice run-time uses the same retry behavior
+     * as for nonmutating operations in case of a potentially
+     * recoverable error.
+     */
     Idempotent
 };
 
+/**
+ * Information about the current method invocation for servers. Each
+ * operation on the server has a <code>Current</code> as its implicit final
+ * parameter. <code>Current</code> is mostly used for Ice services. Most
+ * applications ignore this parameter.
+ * \headerfile Ice/Ice.h
+ */
 struct Current
 {
+    /**
+     * The object adapter.
+     */
     ::std::shared_ptr<::Ice::ObjectAdapter> adapter;
+    /**
+     * Information about the connection over which the current method
+     * invocation was received. If the invocation is direct due to
+     * collocation optimization, this value is set to null.
+     */
     ::std::shared_ptr<::Ice::Connection> con;
+    /**
+     * The Ice object identity.
+     */
     ::Ice::Identity id;
+    /**
+     * The facet.
+     */
     ::std::string facet;
+    /**
+     * The operation name.
+     */
     ::std::string operation;
+    /**
+     * The mode of the operation.
+     */
     ::Ice::OperationMode mode;
+    /**
+     * The request context, as received from the client.
+     */
     ::Ice::Context ctx;
+    /**
+     * The request id unless oneway (0).
+     */
     int requestId;
+    /**
+     * The encoding version used to encode the input and output parameters.
+     */
     ::Ice::EncodingVersion encoding;
 
+    /**
+     * Obtains a tuple containing all of the struct's data members.
+     * @return The data members in a tuple.
+     */
     std::tuple<const ::std::shared_ptr<::Ice::ObjectAdapter>&, const ::std::shared_ptr<::Ice::Connection>&, const ::Ice::Identity&, const ::std::string&, const ::std::string&, const ::Ice::OperationMode&, const ::Ice::Context&, const int&, const ::Ice::EncodingVersion&> ice_tuple() const
     {
         return std::tie(adapter, con, id, facet, operation, mode, ctx, requestId, encoding);
@@ -100,6 +176,7 @@ using Ice::operator!=;
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
@@ -114,36 +191,115 @@ struct StreamableTraits< ::Ice::OperationMode>
 };
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
 namespace Ice
 {
 
+/**
+ * A request context. <code>Context</code> is used to transmit metadata about a
+ * request from the server to the client, such as Quality-of-Service
+ * (QoS) parameters. Each operation on the client has a <code>Context</code> as
+ * its implicit final parameter.
+ */
 typedef ::std::map< ::std::string, ::std::string> Context;
 
+/**
+ * Determines the retry behavior an invocation in case of a (potentially) recoverable error.
+ */
 enum OperationMode
 {
+    /**
+     * Ordinary operations have <code>Normal</code> mode.  These operations
+     * modify object state; invoking such an operation twice in a row
+     * has different semantics than invoking it once. The Ice run time
+     * guarantees that it will not violate at-most-once semantics for
+     * <code>Normal</code> operations.
+     */
     Normal,
+    /**
+     * Operations that use the Slice <code>nonmutating</code> keyword must not
+     * modify object state. For C++, nonmutating operations generate
+     * <code>const</code> member functions in the skeleton. In addition, the Ice
+     * run time will attempt to transparently recover from certain
+     * run-time errors by re-issuing a failed request and propagate
+     * the failure to the application only if the second attempt
+     * fails.
+     *
+     * <p class="Deprecated"><code>Nonmutating</code> is deprecated; Use the
+     * <code>idempotent</code> keyword instead. For C++, to retain the mapping
+     * of <code>nonmutating</code> operations to C++ <code>const</code>
+     * member functions, use the <code>\["cpp:const"]</code> metadata
+     * directive.
+     */
     Nonmutating,
+    /**
+     * Operations that use the Slice <code>idempotent</code> keyword can modify
+     * object state, but invoking an operation twice in a row must
+     * result in the same object state as invoking it once.  For
+     * example, <code>x = 1</code> is an idempotent statement,
+     * whereas <code>x += 1</code> is not. For idempotent
+     * operations, the Ice run-time uses the same retry behavior
+     * as for nonmutating operations in case of a potentially
+     * recoverable error.
+     */
     Idempotent
 };
 
+/**
+ * Information about the current method invocation for servers. Each
+ * operation on the server has a <code>Current</code> as its implicit final
+ * parameter. <code>Current</code> is mostly used for Ice services. Most
+ * applications ignore this parameter.
+ * \headerfile Ice/Ice.h
+ */
 struct Current
 {
+    /**
+     * The object adapter.
+     */
     ::Ice::ObjectAdapterPtr adapter;
+    /**
+     * Information about the connection over which the current method
+     * invocation was received. If the invocation is direct due to
+     * collocation optimization, this value is set to null.
+     */
     ::Ice::ConnectionPtr con;
+    /**
+     * The Ice object identity.
+     */
     ::Ice::Identity id;
+    /**
+     * The facet.
+     */
     ::std::string facet;
+    /**
+     * The operation name.
+     */
     ::std::string operation;
+    /**
+     * The mode of the operation.
+     */
     ::Ice::OperationMode mode;
+    /**
+     * The request context, as received from the client.
+     */
     ::Ice::Context ctx;
+    /**
+     * The request id unless oneway (0).
+     */
     ::Ice::Int requestId;
+    /**
+     * The encoding version used to encode the input and output parameters.
+     */
     ::Ice::EncodingVersion encoding;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
@@ -158,6 +314,7 @@ struct StreamableTraits< ::Ice::OperationMode>
 };
 
 }
+/// \endcond
 
 #endif
 

data/ext/ice/cpp/include/generated/Ice/Endpoint.h

@@ -1,13 +1,8 @@
-// **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// Copyright (c) ZeroC, Inc. All rights reserved.
 //
-// This copy of Ice is licensed to you under the terms described in the
-// ICE_LICENSE file included in this distribution.
 //
-// **********************************************************************
-//
-// Ice version 3.7.0
+// Ice version 3.7.5
 //
 // <auto-generated>
 //
@@ -40,10 +35,10 @@
 #   if ICE_INT_VERSION / 100 != 307
 #       error Ice version mismatch!
 #   endif
-#   if ICE_INT_VERSION % 100 > 50
+#   if ICE_INT_VERSION % 100 >= 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 5
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -76,22 +71,49 @@ class OpaqueEndpointInfo;
 namespace Ice
 {
 
+/**
+ * Uniquely identifies TCP endpoints.
+ */
 constexpr short TCPEndpointType = 1;
 
+/**
+ * Uniquely identifies SSL endpoints.
+ */
 constexpr short SSLEndpointType = 2;
 
+/**
+ * Uniquely identifies UDP endpoints.
+ */
 constexpr short UDPEndpointType = 3;
 
+/**
+ * Uniquely identifies TCP-based WebSocket endpoints.
+ */
 constexpr short WSEndpointType = 4;
 
+/**
+ * Uniquely identifies SSL-based WebSocket endpoints.
+ */
 constexpr short WSSEndpointType = 5;
 
+/**
+ * Uniquely identifies Bluetooth endpoints.
+ */
 constexpr short BTEndpointType = 6;
 
+/**
+ * Uniquely identifies SSL Bluetooth endpoints.
+ */
 constexpr short BTSEndpointType = 7;
 
+/**
+ * Uniquely identifies iAP-based endpoints.
+ */
 constexpr short iAPEndpointType = 8;
 
+/**
+ * Uniquely identifies SSL iAP-based endpoints.
+ */
 constexpr short iAPSEndpointType = 9;
 
 }
@@ -99,6 +121,10 @@ constexpr short iAPSEndpointType = 9;
 namespace Ice
 {
 
+/**
+ * Base class providing access to the endpoint details.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) EndpointInfo
 {
 public:
@@ -112,24 +138,58 @@ public:
     EndpointInfo& operator=(const EndpointInfo&) = default;
     EndpointInfo& operator=(EndpointInfo&&) = default;
 
-    EndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& iceP_underlying, int iceP_timeout, bool iceP_compress) :
-        underlying(::std::move(iceP_underlying)),
-        timeout(iceP_timeout),
-        compress(iceP_compress)
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     */
+    EndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& underlying, int timeout, bool compress) :
+        underlying(underlying),
+        timeout(timeout),
+        compress(compress)
     {
     }
 
-    virtual short type() const = 0;
-
-    virtual bool datagram() const = 0;
-
-    virtual bool secure() const = 0;
-
+    /**
+     * Returns the type of the endpoint.
+     * @return The endpoint type.
+     */
+    virtual short type() const noexcept = 0;
+
+    /**
+     * Returns true if this endpoint is a datagram endpoint.
+     * @return True for a datagram endpoint.
+     */
+    virtual bool datagram() const noexcept = 0;
+
+    /**
+     * Returns true if this endpoint is a secure endpoint.
+     * @return True for a secure endpoint.
+     */
+    virtual bool secure() const noexcept = 0;
+
+    /**
+     * The information of the underyling endpoint of null if there's
+     * no underlying endpoint.
+     */
     ::std::shared_ptr<::Ice::EndpointInfo> underlying;
+    /**
+     * The timeout for the endpoint in milliseconds. 0 means
+     * non-blocking, -1 means no timeout.
+     */
     int timeout;
+    /**
+     * Specifies whether or not compression should be used if
+     * available when using this endpoint.
+     */
     bool compress;
 };
 
+/**
+ * The user-level interface to an endpoint.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) Endpoint
 {
 public:
@@ -139,11 +199,24 @@ public:
     virtual bool operator==(const Endpoint&) const = 0;
     virtual bool operator<(const Endpoint&) const = 0;
 
-    virtual ::std::string toString() const = 0;
-
-    virtual ::std::shared_ptr<::Ice::EndpointInfo> getInfo() const = 0;
+    /**
+     * Return a string representation of the endpoint.
+     * @return The string representation of the endpoint.
+     */
+    virtual ::std::string toString() const noexcept = 0;
+
+    /**
+     * Returns the endpoint information.
+     * @return The endpoint information class.
+     */
+    virtual ::std::shared_ptr<::Ice::EndpointInfo> getInfo() const noexcept = 0;
 };
 
+/**
+ * Provides access to the address details of a IP endpoint.
+ * @see Endpoint
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) IPEndpointInfo : public ::Ice::EndpointInfo
 {
 public:
@@ -157,19 +230,42 @@ public:
     IPEndpointInfo& operator=(const IPEndpointInfo&) = default;
     IPEndpointInfo& operator=(IPEndpointInfo&&) = default;
 
-    IPEndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& iceP_underlying, int iceP_timeout, bool iceP_compress, const ::std::string& iceP_host, int iceP_port, const ::std::string& iceP_sourceAddress) :
-        ::Ice::EndpointInfo(::std::move(iceP_underlying), iceP_timeout, iceP_compress),
-        host(::std::move(iceP_host)),
-        port(iceP_port),
-        sourceAddress(::std::move(iceP_sourceAddress))
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     * @param host The host or address configured with the endpoint.
+     * @param port The port number.
+     * @param sourceAddress The source IP address.
+     */
+    IPEndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& underlying, int timeout, bool compress, const ::std::string& host, int port, const ::std::string& sourceAddress) :
+        EndpointInfo(underlying, timeout, compress),
+        host(host),
+        port(port),
+        sourceAddress(sourceAddress)
     {
     }
 
+    /**
+     * The host or address configured with the endpoint.
+     */
     ::std::string host;
+    /**
+     * The port number.
+     */
     int port;
+    /**
+     * The source IP address.
+     */
     ::std::string sourceAddress;
 };
 
+/**
+ * Provides access to a TCP endpoint information.
+ * @see Endpoint
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) TCPEndpointInfo : public ::Ice::IPEndpointInfo
 {
 public:
@@ -183,12 +279,26 @@ public:
     TCPEndpointInfo& operator=(const TCPEndpointInfo&) = default;
     TCPEndpointInfo& operator=(TCPEndpointInfo&&) = default;
 
-    TCPEndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& iceP_underlying, int iceP_timeout, bool iceP_compress, const ::std::string& iceP_host, int iceP_port, const ::std::string& iceP_sourceAddress) :
-        ::Ice::IPEndpointInfo(::std::move(iceP_underlying), iceP_timeout, iceP_compress, ::std::move(iceP_host), iceP_port, ::std::move(iceP_sourceAddress))
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     * @param host The host or address configured with the endpoint.
+     * @param port The port number.
+     * @param sourceAddress The source IP address.
+     */
+    TCPEndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& underlying, int timeout, bool compress, const ::std::string& host, int port, const ::std::string& sourceAddress) :
+        IPEndpointInfo(underlying, timeout, compress, host, port, sourceAddress)
     {
     }
 };
 
+/**
+ * Provides access to an UDP endpoint information.
+ * @see Endpoint
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) UDPEndpointInfo : public ::Ice::IPEndpointInfo
 {
 public:
@@ -202,17 +312,38 @@ public:
     UDPEndpointInfo& operator=(const UDPEndpointInfo&) = default;
     UDPEndpointInfo& operator=(UDPEndpointInfo&&) = default;
 
-    UDPEndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& iceP_underlying, int iceP_timeout, bool iceP_compress, const ::std::string& iceP_host, int iceP_port, const ::std::string& iceP_sourceAddress, const ::std::string& iceP_mcastInterface, int iceP_mcastTtl) :
-        ::Ice::IPEndpointInfo(::std::move(iceP_underlying), iceP_timeout, iceP_compress, ::std::move(iceP_host), iceP_port, ::std::move(iceP_sourceAddress)),
-        mcastInterface(::std::move(iceP_mcastInterface)),
-        mcastTtl(iceP_mcastTtl)
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     * @param host The host or address configured with the endpoint.
+     * @param port The port number.
+     * @param sourceAddress The source IP address.
+     * @param mcastInterface The multicast interface.
+     * @param mcastTtl The multicast time-to-live (or hops).
+     */
+    UDPEndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& underlying, int timeout, bool compress, const ::std::string& host, int port, const ::std::string& sourceAddress, const ::std::string& mcastInterface, int mcastTtl) :
+        IPEndpointInfo(underlying, timeout, compress, host, port, sourceAddress),
+        mcastInterface(mcastInterface),
+        mcastTtl(mcastTtl)
     {
     }
 
+    /**
+     * The multicast interface.
+     */
     ::std::string mcastInterface;
+    /**
+     * The multicast time-to-live (or hops).
+     */
     int mcastTtl;
 };
 
+/**
+ * Provides access to a WebSocket endpoint information.
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) WSEndpointInfo : public ::Ice::EndpointInfo
 {
 public:
@@ -226,15 +357,30 @@ public:
     WSEndpointInfo& operator=(const WSEndpointInfo&) = default;
     WSEndpointInfo& operator=(WSEndpointInfo&&) = default;
 
-    WSEndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& iceP_underlying, int iceP_timeout, bool iceP_compress, const ::std::string& iceP_resource) :
-        ::Ice::EndpointInfo(::std::move(iceP_underlying), iceP_timeout, iceP_compress),
-        resource(::std::move(iceP_resource))
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     * @param resource The URI configured with the endpoint.
+     */
+    WSEndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& underlying, int timeout, bool compress, const ::std::string& resource) :
+        EndpointInfo(underlying, timeout, compress),
+        resource(resource)
     {
     }
 
+    /**
+     * The URI configured with the endpoint.
+     */
     ::std::string resource;
 };
 
+/**
+ * Provides access to the details of an opaque endpoint.
+ * @see Endpoint
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) OpaqueEndpointInfo : public ::Ice::EndpointInfo
 {
 public:
@@ -248,24 +394,42 @@ public:
     OpaqueEndpointInfo& operator=(const OpaqueEndpointInfo&) = default;
     OpaqueEndpointInfo& operator=(OpaqueEndpointInfo&&) = default;
 
-    OpaqueEndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& iceP_underlying, int iceP_timeout, bool iceP_compress, const ::Ice::EncodingVersion& iceP_rawEncoding, const ::Ice::ByteSeq& iceP_rawBytes) :
-        ::Ice::EndpointInfo(::std::move(iceP_underlying), iceP_timeout, iceP_compress),
-        rawEncoding(::std::move(iceP_rawEncoding)),
-        rawBytes(::std::move(iceP_rawBytes))
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     * @param rawEncoding The encoding version of the opaque endpoint (to decode or encode the rawBytes).
+     * @param rawBytes The raw encoding of the opaque endpoint.
+     */
+    OpaqueEndpointInfo(const ::std::shared_ptr<::Ice::EndpointInfo>& underlying, int timeout, bool compress, const ::Ice::EncodingVersion& rawEncoding, const ::Ice::ByteSeq& rawBytes) :
+        EndpointInfo(underlying, timeout, compress),
+        rawEncoding(rawEncoding),
+        rawBytes(rawBytes)
     {
     }
 
+    /**
+     * The encoding version of the opaque endpoint (to decode or
+     * encode the rawBytes).
+     */
     ::Ice::EncodingVersion rawEncoding;
+    /**
+     * The raw encoding of the opaque endpoint.
+     */
     ::Ice::ByteSeq rawBytes;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
@@ -284,6 +448,7 @@ using WSEndpointInfoPtr = ::std::shared_ptr<WSEndpointInfo>;
 using OpaqueEndpointInfoPtr = ::std::shared_ptr<OpaqueEndpointInfo>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -291,62 +456,107 @@ namespace Ice
 {
 
 class EndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::EndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::EndpointInfo> EndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(EndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< EndpointInfo> EndpointInfoPtr;
 
 class Endpoint;
-ICE_API ::Ice::LocalObject* upCast(::Ice::Endpoint*);
-typedef ::IceInternal::Handle< ::Ice::Endpoint> EndpointPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(Endpoint*);
+/// \endcond
+typedef ::IceInternal::Handle< Endpoint> EndpointPtr;
 
 class IPEndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::IPEndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::IPEndpointInfo> IPEndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(IPEndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< IPEndpointInfo> IPEndpointInfoPtr;
 
 class TCPEndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::TCPEndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::TCPEndpointInfo> TCPEndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(TCPEndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< TCPEndpointInfo> TCPEndpointInfoPtr;
 
 class UDPEndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::UDPEndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::UDPEndpointInfo> UDPEndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(UDPEndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< UDPEndpointInfo> UDPEndpointInfoPtr;
 
 class WSEndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::WSEndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::WSEndpointInfo> WSEndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(WSEndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< WSEndpointInfo> WSEndpointInfoPtr;
 
 class OpaqueEndpointInfo;
-ICE_API ::Ice::LocalObject* upCast(::Ice::OpaqueEndpointInfo*);
-typedef ::IceInternal::Handle< ::Ice::OpaqueEndpointInfo> OpaqueEndpointInfoPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(OpaqueEndpointInfo*);
+/// \endcond
+typedef ::IceInternal::Handle< OpaqueEndpointInfo> OpaqueEndpointInfoPtr;
 
 }
 
 namespace Ice
 {
 
-const ::Ice::Short TCPEndpointType = 1;
+/**
+ * Uniquely identifies TCP endpoints.
+ */
+const Short TCPEndpointType = 1;
 
-const ::Ice::Short SSLEndpointType = 2;
+/**
+ * Uniquely identifies SSL endpoints.
+ */
+const Short SSLEndpointType = 2;
 
-const ::Ice::Short UDPEndpointType = 3;
+/**
+ * Uniquely identifies UDP endpoints.
+ */
+const Short UDPEndpointType = 3;
 
-const ::Ice::Short WSEndpointType = 4;
+/**
+ * Uniquely identifies TCP-based WebSocket endpoints.
+ */
+const Short WSEndpointType = 4;
 
-const ::Ice::Short WSSEndpointType = 5;
+/**
+ * Uniquely identifies SSL-based WebSocket endpoints.
+ */
+const Short WSSEndpointType = 5;
 
-const ::Ice::Short BTEndpointType = 6;
+/**
+ * Uniquely identifies Bluetooth endpoints.
+ */
+const Short BTEndpointType = 6;
 
-const ::Ice::Short BTSEndpointType = 7;
+/**
+ * Uniquely identifies SSL Bluetooth endpoints.
+ */
+const Short BTSEndpointType = 7;
 
-const ::Ice::Short iAPEndpointType = 8;
+/**
+ * Uniquely identifies iAP-based endpoints.
+ */
+const Short iAPEndpointType = 8;
 
-const ::Ice::Short iAPSEndpointType = 9;
+/**
+ * Uniquely identifies SSL iAP-based endpoints.
+ */
+const Short iAPSEndpointType = 9;
 
 }
 
 namespace Ice
 {
 
-class ICE_API EndpointInfo : public virtual ::Ice::LocalObject
+/**
+ * Base class providing access to the endpoint details.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API EndpointInfo : public virtual LocalObject
 {
 public:
 
@@ -358,35 +568,71 @@ public:
     {
     }
 
-    EndpointInfo(const ::Ice::EndpointInfoPtr& iceP_underlying, ::Ice::Int iceP_timeout, bool iceP_compress) :
-        underlying(iceP_underlying),
-        timeout(iceP_timeout),
-        compress(iceP_compress)
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     */
+    EndpointInfo(const ::Ice::EndpointInfoPtr& underlying, ::Ice::Int timeout, bool compress) :
+        underlying(underlying),
+        timeout(timeout),
+        compress(compress)
     {
     }
 
-    virtual ::Ice::Short type() const = 0;
-
-    virtual bool datagram() const = 0;
-
-    virtual bool secure() const = 0;
-
+    /**
+     * Returns the type of the endpoint.
+     * @return The endpoint type.
+     */
+    virtual Short type() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Returns true if this endpoint is a datagram endpoint.
+     * @return True for a datagram endpoint.
+     */
+    virtual bool datagram() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Returns true if this endpoint is a secure endpoint.
+     * @return True for a secure endpoint.
+     */
+    virtual bool secure() const ICE_NOEXCEPT = 0;
+
+    /**
+     * The information of the underyling endpoint of null if there's
+     * no underlying endpoint.
+     */
     ::Ice::EndpointInfoPtr underlying;
+    /**
+     * The timeout for the endpoint in milliseconds. 0 means
+     * non-blocking, -1 means no timeout.
+     */
     ::Ice::Int timeout;
+    /**
+     * Specifies whether or not compression should be used if
+     * available when using this endpoint.
+     */
     bool compress;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const EndpointInfo& lhs, const EndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
 }
 
 inline bool operator<(const EndpointInfo& lhs, const EndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
 }
+/// \endcond
 
-class ICE_API Endpoint : public virtual ::Ice::LocalObject
+/**
+ * The user-level interface to an endpoint.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API Endpoint : public virtual LocalObject
 {
 public:
 
@@ -394,22 +640,37 @@ public:
 
     virtual ~Endpoint();
 
-    virtual ::std::string toString() const = 0;
-
-    virtual ::Ice::EndpointInfoPtr getInfo() const = 0;
+    /**
+     * Return a string representation of the endpoint.
+     * @return The string representation of the endpoint.
+     */
+    virtual ::std::string toString() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Returns the endpoint information.
+     * @return The endpoint information class.
+     */
+    virtual EndpointInfoPtr getInfo() const ICE_NOEXCEPT = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const Endpoint& lhs, const Endpoint& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
 }
 
 inline bool operator<(const Endpoint& lhs, const Endpoint& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
 }
+/// \endcond
 
-class ICE_API IPEndpointInfo : public ::Ice::EndpointInfo
+/**
+ * Provides access to the address details of a IP endpoint.
+ * @see Endpoint
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API IPEndpointInfo : public EndpointInfo
 {
 public:
 
@@ -421,30 +682,55 @@ public:
     {
     }
 
-    IPEndpointInfo(const ::Ice::EndpointInfoPtr& iceP_underlying, ::Ice::Int iceP_timeout, bool iceP_compress, const ::std::string& iceP_host, ::Ice::Int iceP_port, const ::std::string& iceP_sourceAddress) :
-        ::Ice::EndpointInfo(iceP_underlying, iceP_timeout, iceP_compress),
-        host(iceP_host),
-        port(iceP_port),
-        sourceAddress(iceP_sourceAddress)
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     * @param host The host or address configured with the endpoint.
+     * @param port The port number.
+     * @param sourceAddress The source IP address.
+     */
+    IPEndpointInfo(const ::Ice::EndpointInfoPtr& underlying, ::Ice::Int timeout, bool compress, const ::std::string& host, ::Ice::Int port, const ::std::string& sourceAddress) :
+        ::Ice::EndpointInfo(underlying, timeout, compress),
+        host(host),
+        port(port),
+        sourceAddress(sourceAddress)
     {
     }
 
+    /**
+     * The host or address configured with the endpoint.
+     */
     ::std::string host;
+    /**
+     * The port number.
+     */
     ::Ice::Int port;
+    /**
+     * The source IP address.
+     */
     ::std::string sourceAddress;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const IPEndpointInfo& lhs, const IPEndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
 }
 
 inline bool operator<(const IPEndpointInfo& lhs, const IPEndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
 }
+/// \endcond
 
-class ICE_API TCPEndpointInfo : public ::Ice::IPEndpointInfo
+/**
+ * Provides access to a TCP endpoint information.
+ * @see Endpoint
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API TCPEndpointInfo : public IPEndpointInfo
 {
 public:
 
@@ -456,23 +742,39 @@ public:
     {
     }
 
-    TCPEndpointInfo(const ::Ice::EndpointInfoPtr& iceP_underlying, ::Ice::Int iceP_timeout, bool iceP_compress, const ::std::string& iceP_host, ::Ice::Int iceP_port, const ::std::string& iceP_sourceAddress) :
-        ::Ice::IPEndpointInfo(iceP_underlying, iceP_timeout, iceP_compress, iceP_host, iceP_port, iceP_sourceAddress)
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     * @param host The host or address configured with the endpoint.
+     * @param port The port number.
+     * @param sourceAddress The source IP address.
+     */
+    TCPEndpointInfo(const ::Ice::EndpointInfoPtr& underlying, ::Ice::Int timeout, bool compress, const ::std::string& host, ::Ice::Int port, const ::std::string& sourceAddress) :
+        ::Ice::IPEndpointInfo(underlying, timeout, compress, host, port, sourceAddress)
     {
     }
 };
 
+/// \cond INTERNAL
 inline bool operator==(const TCPEndpointInfo& lhs, const TCPEndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
 }
 
 inline bool operator<(const TCPEndpointInfo& lhs, const TCPEndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
 }
+/// \endcond
 
-class ICE_API UDPEndpointInfo : public ::Ice::IPEndpointInfo
+/**
+ * Provides access to an UDP endpoint information.
+ * @see Endpoint
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API UDPEndpointInfo : public IPEndpointInfo
 {
 public:
 
@@ -484,28 +786,51 @@ public:
     {
     }
 
-    UDPEndpointInfo(const ::Ice::EndpointInfoPtr& iceP_underlying, ::Ice::Int iceP_timeout, bool iceP_compress, const ::std::string& iceP_host, ::Ice::Int iceP_port, const ::std::string& iceP_sourceAddress, const ::std::string& iceP_mcastInterface, ::Ice::Int iceP_mcastTtl) :
-        ::Ice::IPEndpointInfo(iceP_underlying, iceP_timeout, iceP_compress, iceP_host, iceP_port, iceP_sourceAddress),
-        mcastInterface(iceP_mcastInterface),
-        mcastTtl(iceP_mcastTtl)
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     * @param host The host or address configured with the endpoint.
+     * @param port The port number.
+     * @param sourceAddress The source IP address.
+     * @param mcastInterface The multicast interface.
+     * @param mcastTtl The multicast time-to-live (or hops).
+     */
+    UDPEndpointInfo(const ::Ice::EndpointInfoPtr& underlying, ::Ice::Int timeout, bool compress, const ::std::string& host, ::Ice::Int port, const ::std::string& sourceAddress, const ::std::string& mcastInterface, ::Ice::Int mcastTtl) :
+        ::Ice::IPEndpointInfo(underlying, timeout, compress, host, port, sourceAddress),
+        mcastInterface(mcastInterface),
+        mcastTtl(mcastTtl)
     {
     }
 
+    /**
+     * The multicast interface.
+     */
     ::std::string mcastInterface;
+    /**
+     * The multicast time-to-live (or hops).
+     */
     ::Ice::Int mcastTtl;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const UDPEndpointInfo& lhs, const UDPEndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
 }
 
 inline bool operator<(const UDPEndpointInfo& lhs, const UDPEndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
 }
+/// \endcond
 
-class ICE_API WSEndpointInfo : public ::Ice::EndpointInfo
+/**
+ * Provides access to a WebSocket endpoint information.
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API WSEndpointInfo : public EndpointInfo
 {
 public:
 
@@ -517,26 +842,43 @@ public:
     {
     }
 
-    WSEndpointInfo(const ::Ice::EndpointInfoPtr& iceP_underlying, ::Ice::Int iceP_timeout, bool iceP_compress, const ::std::string& iceP_resource) :
-        ::Ice::EndpointInfo(iceP_underlying, iceP_timeout, iceP_compress),
-        resource(iceP_resource)
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     * @param resource The URI configured with the endpoint.
+     */
+    WSEndpointInfo(const ::Ice::EndpointInfoPtr& underlying, ::Ice::Int timeout, bool compress, const ::std::string& resource) :
+        ::Ice::EndpointInfo(underlying, timeout, compress),
+        resource(resource)
     {
     }
 
+    /**
+     * The URI configured with the endpoint.
+     */
     ::std::string resource;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const WSEndpointInfo& lhs, const WSEndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
 }
 
 inline bool operator<(const WSEndpointInfo& lhs, const WSEndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
 }
+/// \endcond
 
-class ICE_API OpaqueEndpointInfo : public ::Ice::EndpointInfo
+/**
+ * Provides access to the details of an opaque endpoint.
+ * @see Endpoint
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API OpaqueEndpointInfo : public EndpointInfo
 {
 public:
 
@@ -548,33 +890,52 @@ public:
     {
     }
 
-    OpaqueEndpointInfo(const ::Ice::EndpointInfoPtr& iceP_underlying, ::Ice::Int iceP_timeout, bool iceP_compress, const ::Ice::EncodingVersion& iceP_rawEncoding, const ::Ice::ByteSeq& iceP_rawBytes) :
-        ::Ice::EndpointInfo(iceP_underlying, iceP_timeout, iceP_compress),
-        rawEncoding(iceP_rawEncoding),
-        rawBytes(iceP_rawBytes)
+    /**
+     * One-shot constructor to initialize all data members.
+     * @param underlying The information of the underyling endpoint of null if there's no underlying endpoint.
+     * @param timeout The timeout for the endpoint in milliseconds.
+     * @param compress Specifies whether or not compression should be used if available when using this endpoint.
+     * @param rawEncoding The encoding version of the opaque endpoint (to decode or encode the rawBytes).
+     * @param rawBytes The raw encoding of the opaque endpoint.
+     */
+    OpaqueEndpointInfo(const ::Ice::EndpointInfoPtr& underlying, ::Ice::Int timeout, bool compress, const ::Ice::EncodingVersion& rawEncoding, const ::Ice::ByteSeq& rawBytes) :
+        ::Ice::EndpointInfo(underlying, timeout, compress),
+        rawEncoding(rawEncoding),
+        rawBytes(rawBytes)
     {
     }
 
+    /**
+     * The encoding version of the opaque endpoint (to decode or
+     * encode the rawBytes).
+     */
     ::Ice::EncodingVersion rawEncoding;
+    /**
+     * The raw encoding of the opaque endpoint.
+     */
     ::Ice::ByteSeq rawBytes;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const OpaqueEndpointInfo& lhs, const OpaqueEndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) == static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
 }
 
 inline bool operator<(const OpaqueEndpointInfo& lhs, const OpaqueEndpointInfo& rhs)
 {
-    return static_cast<const ::Ice::LocalObject&>(lhs) < static_cast<const ::Ice::LocalObject&>(rhs);
+    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
 }
+/// \endcond
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
 #endif