zeroc-ice 3.7.0 → 3.7.1

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

@@ -1,13 +1,13 @@
 // **********************************************************************
 //
-// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
+// Copyright (c) 2003-2018 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.1
 //
 // <auto-generated>
 //
@@ -61,7 +61,7 @@
 #   if ICE_INT_VERSION % 100 > 50
 #       error Beta header file detected
 #   endif
-#   if ICE_INT_VERSION % 100 < 0
+#   if ICE_INT_VERSION % 100 < 1
 #       error Ice patch level mismatch!
 #   endif
 #endif
@@ -88,10 +88,31 @@ class Communicator;
 namespace Ice
 {
 
+/**
+ * The output mode for xxxToString method such as identityToString and proxyToString.
+ * The actual encoding format for the string is the same for all modes: you
+ * don't need to specify an encoding format or mode when reading such a string.
+ */
 enum class ToStringMode : unsigned char
 {
+    /**
+     * Characters with ordinal values greater than 127 are kept as-is in the resulting string.
+     * Non-printable ASCII characters with ordinal values 127 and below are encoded as \\t, \\n (etc.)
+     * or \\unnnn.
+     */
     Unicode,
+    /**
+     * Characters with ordinal values greater than 127 are encoded as universal character names in
+     * the resulting string: \\unnnn for BMP characters and \\Unnnnnnnn for non-BMP characters.
+     * Non-printable ASCII characters with ordinal values 127 and below are encoded as \\t, \\n (etc.)
+     * or \\unnnn.
+     */
     ASCII,
+    /**
+     * Characters with ordinal values greater than 127 are encoded as a sequence of UTF-8 bytes using
+     * octal escapes. Characters with ordinal values 127 and below are encoded as \\t, \\n (etc.) or
+     * an octal escape. Use this mode to generate strings compatible with Ice 3.6 and earlier.
+     */
     Compat
 };
 
@@ -100,74 +121,382 @@ enum class ToStringMode : unsigned char
 namespace Ice
 {
 
+/**
+ * The central object in Ice. One or more communicators can be
+ * instantiated for an Ice application. Communicator instantiation
+ * is language-specific, and not specified in Slice code.
+ * @see Logger
+ * @see ObjectAdapter
+ * @see Properties
+ * @see ValueFactory
+ * \headerfile Ice/Ice.h
+ */
 class ICE_CLASS(ICE_API) Communicator
 {
 public:
 
     ICE_MEMBER(ICE_API) virtual ~Communicator();
 
+    /**
+     * Destroy the communicator. This operation calls {@link #shutdown}
+     * implicitly.  Calling {@link #destroy} cleans up memory, and shuts down
+     * this communicator's client functionality and destroys all object
+     * adapters. Subsequent calls to {@link #destroy} are ignored.
+     * @see #shutdown
+     * @see ObjectAdapter#destroy
+     */
     virtual void destroy() noexcept = 0;
 
-    virtual void shutdown() = 0;
-
-    virtual void waitForShutdown() = 0;
-
-    virtual bool isShutdown() const = 0;
-
-    virtual ::std::shared_ptr<::Ice::ObjectPrx> stringToProxy(const ::std::string&) const = 0;
-
-    virtual ::std::string proxyToString(const ::std::shared_ptr<::Ice::ObjectPrx>&) const = 0;
-
-    virtual ::std::shared_ptr<::Ice::ObjectPrx> propertyToProxy(const ::std::string&) const = 0;
-
-    virtual ::Ice::PropertyDict proxyToProperty(const ::std::shared_ptr<::Ice::ObjectPrx>&, const ::std::string&) const = 0;
-
-    ICE_DEPRECATED_API("stringToIdentity() is deprecated, use the static stringToIdentity() method instead.") virtual ::Ice::Identity stringToIdentity(const ::std::string&) const = 0;
-
-    virtual ::std::string identityToString(const ::Ice::Identity&) const = 0;
-
-    virtual ::std::shared_ptr<::Ice::ObjectAdapter> createObjectAdapter(const ::std::string&) = 0;
-
-    virtual ::std::shared_ptr<::Ice::ObjectAdapter> createObjectAdapterWithEndpoints(const ::std::string&, const ::std::string&) = 0;
-
-    virtual ::std::shared_ptr<::Ice::ObjectAdapter> createObjectAdapterWithRouter(const ::std::string&, const ::std::shared_ptr<::Ice::RouterPrx>&) = 0;
-
-    ICE_DEPRECATED_API("addObjectFactory() is deprecated, use ValueFactoryManager::add() instead.") virtual void addObjectFactory(const ::std::shared_ptr<::Ice::ObjectFactory>&, const ::std::string&) = 0;
-
-    ICE_DEPRECATED_API("findObjectFactory() is deprecated, use ValueFactoryManager::find() instead.") virtual ::std::shared_ptr<::Ice::ObjectFactory> findObjectFactory(const ::std::string&) const = 0;
-
-    virtual ::std::shared_ptr<::Ice::ImplicitContext> getImplicitContext() const = 0;
-
-    virtual ::std::shared_ptr<::Ice::Properties> getProperties() const = 0;
-
-    virtual ::std::shared_ptr<::Ice::Logger> getLogger() const = 0;
-
-    virtual ::std::shared_ptr<::Ice::Instrumentation::CommunicatorObserver> getObserver() const = 0;
-
+    /**
+     * Shuts down this communicator's server functionality, which
+     * includes the deactivation of all object adapters. Attempts to use a
+     * deactivated object adapter raise ObjectAdapterDeactivatedException.
+     * Subsequent calls to shutdown are ignored.
+     *
+     * After shutdown returns, no new requests are processed. However, requests
+     * that have been started before shutdown was called might still be active.
+     * You can use {@link #waitForShutdown} to wait for the completion of all
+     * requests.
+     * @see #destroy
+     * @see #waitForShutdown
+     * @see ObjectAdapter#deactivate
+     */
+    virtual void shutdown() noexcept = 0;
+
+    /**
+     * Wait until the application has called {@link #shutdown} (or {@link #destroy}).
+     * On the server side, this operation blocks the calling thread
+     * until all currently-executing operations have completed.
+     * On the client side, the operation simply blocks until another
+     * thread has called {@link #shutdown} or {@link #destroy}.
+     *
+     * A typical use of this operation is to call it from the main thread,
+     * which then waits until some other thread calls {@link #shutdown}.
+     * After shut-down is complete, the main thread returns and can do some
+     * cleanup work before it finally calls {@link #destroy} to shut down
+     * the client functionality, and then exits the application.
+     * @see #shutdown
+     * @see #destroy
+     * @see ObjectAdapter#waitForDeactivate
+     */
+    virtual void waitForShutdown() noexcept = 0;
+
+    /**
+     * Check whether communicator has been shut down.
+     * @return True if the communicator has been shut down; false otherwise.
+     * @see #shutdown
+     */
+    virtual bool isShutdown() const noexcept = 0;
+
+    /**
+     * Convert a stringified proxy into a proxy. For example,
+     * <tt>MyCategory/MyObject:tcp -h some_host -p
+     * 10000</tt> creates a proxy that refers to the Ice object
+     * having an identity with a name "MyObject" and a category
+     * "MyCategory", with the server running on host "some_host", port
+     * 10000. If the stringified proxy does not parse correctly, the
+     * operation throws one of ProxyParseException, EndpointParseException,
+     * or IdentityParseException. Refer to the Ice manual for a detailed
+     * description of the syntax supported by stringified proxies.
+     * @param str The stringified proxy to convert into a proxy.
+     * @return The proxy, or nil if <tt>str</tt> is an empty string.
+     * @see #proxyToString
+     */
+    virtual ::std::shared_ptr<::Ice::ObjectPrx> stringToProxy(const ::std::string& str) const = 0;
+
+    /**
+     * Convert a proxy into a string.
+     * @param obj The proxy to convert into a stringified proxy.
+     * @return The stringified proxy, or an empty string if
+     * <tt>obj</tt> is nil.
+     * @see #stringToProxy
+     */
+    virtual ::std::string proxyToString(const ::std::shared_ptr<ObjectPrx>& obj) const = 0;
+
+    /**
+     * Convert a set of proxy properties into a proxy. The "base"
+     * name supplied in the <tt>property</tt> argument refers to a
+     * property containing a stringified proxy, such as
+     * <tt>MyProxy=id:tcp -h localhost -p 10000</tt>. Additional
+     * properties configure local settings for the proxy, such as
+     * <tt>MyProxy.PreferSecure=1</tt>. The "Properties"
+     * appendix in the Ice manual describes each of the supported
+     * proxy properties.
+     * @param property The base property name.
+     * @return The proxy.
+     */
+    virtual ::std::shared_ptr<::Ice::ObjectPrx> propertyToProxy(const ::std::string& property) const = 0;
+
+    /**
+     * Convert a proxy to a set of proxy properties.
+     * @param proxy The proxy.
+     * @param property The base property name.
+     * @return The property set.
+     */
+    virtual ::Ice::PropertyDict proxyToProperty(const ::std::shared_ptr<ObjectPrx>& proxy, const ::std::string& property) const = 0;
+
+    /**
+     * Convert a string into an identity. If the string does not parse
+     * correctly, the operation throws IdentityParseException.
+     * @param str The string to convert into an identity.
+     * @return The identity.
+     * @see #identityToString
+     *
+     * @deprecated stringToIdentity() is deprecated, use the static stringToIdentity() method instead.
+     */
+    ICE_DEPRECATED_API("stringToIdentity() is deprecated, use the static stringToIdentity() method instead.") virtual ::Ice::Identity stringToIdentity(const ::std::string& str) const = 0;
+
+    /**
+     * Convert an identity into a string.
+     * @param ident The identity to convert into a string.
+     * @return The "stringified" identity.
+     * @see #stringToIdentity
+     */
+    virtual ::std::string identityToString(const Identity& ident) const = 0;
+
+    /**
+     * Create a new object adapter. The endpoints for the object
+     * adapter are taken from the property <tt><em>name</em>.Endpoints</tt>.
+     *
+     * It is legal to create an object adapter with the empty string as
+     * its name. Such an object adapter is accessible via bidirectional
+     * connections or by collocated invocations that originate from the
+     * same communicator as is used by the adapter.
+     *
+     * Attempts to create a named object adapter for which no configuration
+     * can be found raise InitializationException.
+     * @param name The object adapter name.
+     * @return The new object adapter.
+     * @see #createObjectAdapterWithEndpoints
+     * @see ObjectAdapter
+     * @see Properties
+     */
+    virtual ::std::shared_ptr<::Ice::ObjectAdapter> createObjectAdapter(const ::std::string& name) = 0;
+
+    /**
+     * Create a new object adapter with endpoints. This operation sets
+     * the property <tt><em>name</em>.Endpoints</tt>, and then calls
+     * {@link #createObjectAdapter}. It is provided as a convenience
+     * function.
+     *
+     * Calling this operation with an empty name will result in a
+     * UUID being generated for the name.
+     * @param name The object adapter name.
+     * @param endpoints The endpoints for the object adapter.
+     * @return The new object adapter.
+     * @see #createObjectAdapter
+     * @see ObjectAdapter
+     * @see Properties
+     */
+    virtual ::std::shared_ptr<::Ice::ObjectAdapter> createObjectAdapterWithEndpoints(const ::std::string& name, const ::std::string& endpoints) = 0;
+
+    /**
+     * Create a new object adapter with a router. This operation
+     * creates a routed object adapter.
+     *
+     * Calling this operation with an empty name will result in a
+     * UUID being generated for the name.
+     * @param name The object adapter name.
+     * @param rtr The router.
+     * @return The new object adapter.
+     * @see #createObjectAdapter
+     * @see ObjectAdapter
+     * @see Properties
+     */
+    virtual ::std::shared_ptr<::Ice::ObjectAdapter> createObjectAdapterWithRouter(const ::std::string& name, const ::std::shared_ptr<RouterPrx>& rtr) = 0;
+
+    /**
+     * Add an object factory to this communicator. Installing a
+     * factory with an id for which a factory is already registered
+     * throws AlreadyRegisteredException.
+     *
+     * When unmarshaling an Ice object, the Ice run time reads the
+     * most-derived type id off the wire and attempts to create an
+     * instance of the type using a factory. If no instance is created,
+     * either because no factory was found, or because all factories
+     * returned nil, the behavior of the Ice run time depends on the
+     * format with which the object was marshaled:
+     *
+     * If the object uses the "sliced" format, Ice ascends the class
+     * hierarchy until it finds a type that is recognized by a factory,
+     * or it reaches the least-derived type. If no factory is found that
+     * can create an instance, the run time throws NoValueFactoryException.
+     *
+     * If the object uses the "compact" format, Ice immediately raises
+     * NoValueFactoryException.
+     *
+     * The following order is used to locate a factory for a type:
+     *
+     * <ol>
+     *
+     * <li>The Ice run-time looks for a factory registered
+     * specifically for the type.</li>
+     *
+     * <li>If no instance has been created, the Ice run-time looks
+     * for the default factory, which is registered with an empty type id.
+     * </li>
+     *
+     * <li>If no instance has been created by any of the preceding
+     * steps, the Ice run-time looks for a factory that may have been
+     * statically generated by the language mapping for non-abstract classes.
+     * </li>
+     *
+     * </ol>
+     * @param factory The factory to add.
+     * @param id The type id for which the factory can create instances, or
+     * an empty string for the default factory.
+     * @see #findObjectFactory
+     * @see ObjectFactory
+     * @see ValueFactoryManager#add
+     *
+     * @deprecated addObjectFactory() is deprecated, use ValueFactoryManager::add() instead.
+     */
+    ICE_DEPRECATED_API("addObjectFactory() is deprecated, use ValueFactoryManager::add() instead.") virtual void addObjectFactory(const ::std::shared_ptr<ObjectFactory>& factory, const ::std::string& id) = 0;
+
+    /**
+     * Find an object factory registered with this communicator.
+     * @param id The type id for which the factory can create instances,
+     * or an empty string for the default factory.
+     * @return The object factory, or null if no object factory was
+     * found for the given id.
+     * @see #addObjectFactory
+     * @see ObjectFactory
+     * @see ValueFactoryManager#find
+     *
+     * @deprecated findObjectFactory() is deprecated, use ValueFactoryManager::find() instead.
+     */
+    ICE_DEPRECATED_API("findObjectFactory() is deprecated, use ValueFactoryManager::find() instead.") virtual ::std::shared_ptr<::Ice::ObjectFactory> findObjectFactory(const ::std::string& id) const noexcept = 0;
+
+    /**
+     * Get the implicit context associated with this communicator.
+     * @return The implicit context associated with this communicator;
+     * returns null when the property Ice.ImplicitContext is not set
+     * or is set to None.
+     */
+    virtual ::std::shared_ptr<::Ice::ImplicitContext> getImplicitContext() const noexcept = 0;
+
+    /**
+     * Get the properties for this communicator.
+     * @return This communicator's properties.
+     * @see Properties
+     */
+    virtual ::std::shared_ptr<::Ice::Properties> getProperties() const noexcept = 0;
+
+    /**
+     * Get the logger for this communicator.
+     * @return This communicator's logger.
+     * @see Logger
+     */
+    virtual ::std::shared_ptr<::Ice::Logger> getLogger() const noexcept = 0;
+
+    /**
+     * Get the observer resolver object for this communicator.
+     * @return This communicator's observer resolver object.
+     */
+    virtual ::std::shared_ptr<::Ice::Instrumentation::CommunicatorObserver> getObserver() const noexcept = 0;
+
+    /**
+     * Get the default router this communicator.
+     * @return The default router for this communicator.
+     * @see #setDefaultRouter
+     * @see Router
+     */
     virtual ::std::shared_ptr<::Ice::RouterPrx> getDefaultRouter() const = 0;
 
-    virtual void setDefaultRouter(const ::std::shared_ptr<::Ice::RouterPrx>&) = 0;
-
+    /**
+     * Set a default router for this communicator. All newly
+     * created proxies will use this default router. To disable the
+     * default router, null can be used. Note that this
+     * operation has no effect on existing proxies.
+     *
+     * You can also set a router for an individual proxy
+     * by calling the operation <tt>ice_router</tt> on the proxy.
+     * @param rtr The default router to use for this communicator.
+     * @see #getDefaultRouter
+     * @see #createObjectAdapterWithRouter
+     * @see Router
+     */
+    virtual void setDefaultRouter(const ::std::shared_ptr<RouterPrx>& rtr) = 0;
+
+    /**
+     * Get the default locator this communicator.
+     * @return The default locator for this communicator.
+     * @see #setDefaultLocator
+     * @see Locator
+     */
     virtual ::std::shared_ptr<::Ice::LocatorPrx> getDefaultLocator() const = 0;
 
-    virtual void setDefaultLocator(const ::std::shared_ptr<::Ice::LocatorPrx>&) = 0;
-
+    /**
+     * Set a default Ice locator for this communicator. All newly
+     * created proxy and object adapters will use this default
+     * locator. To disable the default locator, null can be used.
+     * Note that this operation has no effect on existing proxies or
+     * object adapters.
+     *
+     * You can also set a locator for an individual proxy by calling the
+     * operation <tt>ice_locator</tt> on the proxy, or for an object adapter
+     * by calling {@link ObjectAdapter#setLocator} on the object adapter.
+     * @param loc The default locator to use for this communicator.
+     * @see #getDefaultLocator
+     * @see Locator
+     * @see ObjectAdapter#setLocator
+     */
+    virtual void setDefaultLocator(const ::std::shared_ptr<LocatorPrx>& loc) = 0;
+
+    /**
+     * Get the plug-in manager for this communicator.
+     * @return This communicator's plug-in manager.
+     * @see PluginManager
+     */
     virtual ::std::shared_ptr<::Ice::PluginManager> getPluginManager() const = 0;
 
-    virtual ::std::shared_ptr<::Ice::ValueFactoryManager> getValueFactoryManager() const = 0;
-
-    virtual void flushBatchRequests(::Ice::CompressBatch compress)
+    /**
+     * Get the value factory manager for this communicator.
+     * @return This communicator's value factory manager.
+     * @see ValueFactoryManager
+     */
+    virtual ::std::shared_ptr<::Ice::ValueFactoryManager> getValueFactoryManager() const noexcept = 0;
+
+    /**
+     * Flush any pending batch requests for this communicator.
+     * This means all batch requests invoked on fixed proxies
+     * for all connections associated with the communicator.
+     * Any errors that occur while flushing a connection are ignored.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     */
+    virtual void flushBatchRequests(CompressBatch compress)
     {
         flushBatchRequestsAsync(compress).get();
     }
 
+    /**
+     * Flush any pending batch requests for this communicator.
+     * This means all batch requests invoked on fixed proxies
+     * for all connections associated with the communicator.
+     * Any errors that occur while flushing a connection are ignored.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     * @param exception The exception callback.
+     * @param sent The sent callback.
+     * @return A function that can be called to cancel the invocation locally.
+     */
     virtual ::std::function<void()>
-    flushBatchRequestsAsync(::Ice::CompressBatch compress,
+    flushBatchRequestsAsync(CompressBatch compress,
                             ::std::function<void(::std::exception_ptr)> exception,
                             ::std::function<void(bool)> sent = nullptr) = 0;
 
+    /**
+     * Flush any pending batch requests for this communicator.
+     * This means all batch requests invoked on fixed proxies
+     * for all connections associated with the communicator.
+     * Any errors that occur while flushing a connection are ignored.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     * @return The future object for the invocation.
+     */
     template<template<typename> class P = ::std::promise>
-    auto flushBatchRequestsAsync(::Ice::CompressBatch compress)
+    auto flushBatchRequestsAsync(CompressBatch compress)
         -> decltype(::std::declval<P<void>>().get_future())
     {
         using Promise = P<void>;
@@ -184,32 +513,88 @@ public:
         return promise->get_future();
     }
 
-    virtual ::std::shared_ptr<::Ice::ObjectPrx> createAdmin(const ::std::shared_ptr<::Ice::ObjectAdapter>&, const ::Ice::Identity&) = 0;
-
+    /**
+     * Add the Admin object with all its facets to the provided object adapter.
+     * If Ice.Admin.ServerId is set and the provided object adapter has a {@link Locator},
+     * createAdmin registers the Admin's Process facet with the {@link Locator}'s {@link LocatorRegistry}.
+     *
+     * createAdmin call only be called once; subsequent calls raise InitializationException.
+     * @param adminAdapter The object adapter used to host the Admin object; if null and
+     * Ice.Admin.Endpoints is set, create, activate and use the Ice.Admin object adapter.
+     * @param adminId The identity of the Admin object.
+     * @return A proxy to the main ("") facet of the Admin object. Never returns a null proxy.
+     * @see #getAdmin
+     */
+    virtual ::std::shared_ptr<::Ice::ObjectPrx> createAdmin(const ::std::shared_ptr<ObjectAdapter>& adminAdapter, const Identity& adminId) = 0;
+
+    /**
+     * Get a proxy to the main facet of the Admin object.
+     *
+     * getAdmin also creates the Admin object and creates and activates the Ice.Admin object
+     * adapter to host this Admin object if Ice.Admin.Enpoints is set. The identity of the Admin
+     * object created by getAdmin is {value of Ice.Admin.InstanceName}/admin, or {UUID}/admin
+     * when Ice.Admin.InstanceName is not set.
+     *
+     * If Ice.Admin.DelayCreation is 0 or not set, getAdmin is called by the communicator
+     * initialization, after initialization of all plugins.
+     * @return A proxy to the main ("") facet of the Admin object, or a null proxy if no
+     * Admin object is configured.
+     * @see #createAdmin
+     */
     virtual ::std::shared_ptr<::Ice::ObjectPrx> getAdmin() const = 0;
 
-    virtual void addAdminFacet(const ::std::shared_ptr<::Ice::Object>&, const ::std::string&) = 0;
-
-    virtual ::std::shared_ptr<::Ice::Object> removeAdminFacet(const ::std::string&) = 0;
-
-    virtual ::std::shared_ptr<::Ice::Object> findAdminFacet(const ::std::string&) = 0;
-
+    /**
+     * Add a new facet to the Admin object.
+     * Adding a servant with a facet that is already registered
+     * throws AlreadyRegisteredException.
+     * @param servant The servant that implements the new Admin facet.
+     * @param facet The name of the new Admin facet.
+     */
+    virtual void addAdminFacet(const ::std::shared_ptr<Object>& servant, const ::std::string& facet) = 0;
+
+    /**
+     * Remove the following facet to the Admin object.
+     * Removing a facet that was not previously registered throws
+     * NotRegisteredException.
+     * @param facet The name of the Admin facet.
+     * @return The servant associated with this Admin facet.
+     */
+    virtual ::std::shared_ptr<::Ice::Object> removeAdminFacet(const ::std::string& facet) = 0;
+
+    /**
+     * Returns a facet of the Admin object.
+     * @param facet The name of the Admin facet.
+     * @return The servant associated with this Admin facet, or
+     * null if no facet is registered with the given name.
+     */
+    virtual ::std::shared_ptr<::Ice::Object> findAdminFacet(const ::std::string& facet) = 0;
+
+    /**
+     * Returns a map of all facets of the Admin object.
+     * @return A collection containing all the facet names and
+     * servants of the Admin object.
+     * @see #findAdminFacet
+     */
     virtual ::Ice::FacetMap findAllAdminFacets() = 0;
 };
 
 }
 
+/// \cond STREAM
 namespace Ice
 {
 
 }
+/// \endcond
 
+/// \cond INTERNAL
 namespace Ice
 {
 
 using CommunicatorPtr = ::std::shared_ptr<Communicator>;
 
 }
+/// \endcond
 
 #else // C++98 mapping
 
@@ -222,31 +607,61 @@ namespace Ice
 {
 
 class Communicator;
-ICE_API ::Ice::LocalObject* upCast(::Ice::Communicator*);
-typedef ::IceInternal::Handle< ::Ice::Communicator> CommunicatorPtr;
+/// \cond INTERNAL
+ICE_API LocalObject* upCast(Communicator*);
+/// \endcond
+typedef ::IceInternal::Handle< Communicator> CommunicatorPtr;
 
 }
 
 namespace Ice
 {
 
+/**
+ * The output mode for xxxToString method such as identityToString and proxyToString.
+ * The actual encoding format for the string is the same for all modes: you
+ * don't need to specify an encoding format or mode when reading such a string.
+ */
 enum ToStringMode
 {
+    /**
+     * Characters with ordinal values greater than 127 are kept as-is in the resulting string.
+     * Non-printable ASCII characters with ordinal values 127 and below are encoded as \\t, \\n (etc.)
+     * or \\unnnn.
+     */
     Unicode,
+    /**
+     * Characters with ordinal values greater than 127 are encoded as universal character names in
+     * the resulting string: \\unnnn for BMP characters and \\Unnnnnnnn for non-BMP characters.
+     * Non-printable ASCII characters with ordinal values 127 and below are encoded as \\t, \\n (etc.)
+     * or \\unnnn.
+     */
     ASCII,
+    /**
+     * Characters with ordinal values greater than 127 are encoded as a sequence of UTF-8 bytes using
+     * octal escapes. Characters with ordinal values 127 and below are encoded as \\t, \\n (etc.) or
+     * an octal escape. Use this mode to generate strings compatible with Ice 3.6 and earlier.
+     */
     Compat
 };
 
 }
 
+/// \cond INTERNAL
 namespace IceAsync
 {
 
 }
+/// \endcond
 
 namespace Ice
 {
 
+/**
+ * Base class for asynchronous callback wrapper classes used for calls to
+ * IceProxy::Ice::Communicator::begin_flushBatchRequests.
+ * Create a wrapper instance by calling ::Ice::newCallback_Communicator_flushBatchRequests.
+ */
 class Callback_Communicator_flushBatchRequests_Base : public virtual ::IceInternal::CallbackBase { };
 typedef ::IceUtil::Handle< Callback_Communicator_flushBatchRequests_Base> Callback_Communicator_flushBatchRequestsPtr;
 
@@ -260,7 +675,17 @@ namespace IceProxy
 namespace Ice
 {
 
-class ICE_API Communicator : public virtual ::Ice::LocalObject
+/**
+ * The central object in Ice. One or more communicators can be
+ * instantiated for an Ice application. Communicator instantiation
+ * is language-specific, and not specified in Slice code.
+ * @see Logger
+ * @see ObjectAdapter
+ * @see Properties
+ * @see ValueFactory
+ * \headerfile Ice/Ice.h
+ */
+class ICE_API Communicator : public virtual LocalObject
 {
 public:
 
@@ -268,95 +693,467 @@ public:
 
     virtual ~Communicator();
 
+    /**
+     * Destroy the communicator. This operation calls {@link #shutdown}
+     * implicitly.  Calling {@link #destroy} cleans up memory, and shuts down
+     * this communicator's client functionality and destroys all object
+     * adapters. Subsequent calls to {@link #destroy} are ignored.
+     * @see #shutdown
+     * @see ObjectAdapter#destroy
+     */
     virtual void destroy() ICE_NOEXCEPT = 0;
 
-    virtual void shutdown() = 0;
-
-    virtual void waitForShutdown() = 0;
-
-    virtual bool isShutdown() const = 0;
-
-    virtual ::Ice::ObjectPrx stringToProxy(const ::std::string&) const = 0;
-
-    virtual ::std::string proxyToString(const ::Ice::ObjectPrx&) const = 0;
-
-    virtual ::Ice::ObjectPrx propertyToProxy(const ::std::string&) const = 0;
-
-    virtual ::Ice::PropertyDict proxyToProperty(const ::Ice::ObjectPrx&, const ::std::string&) const = 0;
-
-    ICE_DEPRECATED_API("stringToIdentity() is deprecated, use the static stringToIdentity() method instead.") virtual ::Ice::Identity stringToIdentity(const ::std::string&) const = 0;
-
-    virtual ::std::string identityToString(const ::Ice::Identity&) const = 0;
-
-    virtual ::Ice::ObjectAdapterPtr createObjectAdapter(const ::std::string&) = 0;
-
-    virtual ::Ice::ObjectAdapterPtr createObjectAdapterWithEndpoints(const ::std::string&, const ::std::string&) = 0;
-
-    virtual ::Ice::ObjectAdapterPtr createObjectAdapterWithRouter(const ::std::string&, const ::Ice::RouterPrx&) = 0;
-
-    ICE_DEPRECATED_API("addObjectFactory() is deprecated, use ValueFactoryManager::add() instead.") virtual void addObjectFactory(const ::Ice::ObjectFactoryPtr&, const ::std::string&) = 0;
-
-    ICE_DEPRECATED_API("findObjectFactory() is deprecated, use ValueFactoryManager::find() instead.") virtual ::Ice::ObjectFactoryPtr findObjectFactory(const ::std::string&) const = 0;
-
-    virtual ::Ice::ImplicitContextPtr getImplicitContext() const = 0;
-
-    virtual ::Ice::PropertiesPtr getProperties() const = 0;
-
-    virtual ::Ice::LoggerPtr getLogger() const = 0;
-
-    virtual ::Ice::Instrumentation::CommunicatorObserverPtr getObserver() const = 0;
-
-    virtual ::Ice::RouterPrx getDefaultRouter() const = 0;
-
-    virtual void setDefaultRouter(const ::Ice::RouterPrx&) = 0;
-
-    virtual ::Ice::LocatorPrx getDefaultLocator() const = 0;
-
-    virtual void setDefaultLocator(const ::Ice::LocatorPrx&) = 0;
-
-    virtual ::Ice::PluginManagerPtr getPluginManager() const = 0;
-
-    virtual ::Ice::ValueFactoryManagerPtr getValueFactoryManager() const = 0;
-
-    virtual void flushBatchRequests(::Ice::CompressBatch) = 0;
-
-    virtual ::Ice::AsyncResultPtr begin_flushBatchRequests(::Ice::CompressBatch compress) = 0;
-
-    virtual ::Ice::AsyncResultPtr begin_flushBatchRequests(::Ice::CompressBatch compress, const ::Ice::CallbackPtr& del, const ::Ice::LocalObjectPtr& cookie = 0) = 0;
-
-    virtual ::Ice::AsyncResultPtr begin_flushBatchRequests(::Ice::CompressBatch compress, const ::Ice::Callback_Communicator_flushBatchRequestsPtr& del, const ::Ice::LocalObjectPtr& cookie = 0) = 0;
-
-    virtual void end_flushBatchRequests(const ::Ice::AsyncResultPtr&) = 0;
-
-    virtual ::Ice::ObjectPrx createAdmin(const ::Ice::ObjectAdapterPtr&, const ::Ice::Identity&) = 0;
-
-    virtual ::Ice::ObjectPrx getAdmin() const = 0;
-
-    virtual void addAdminFacet(const ::Ice::ObjectPtr&, const ::std::string&) = 0;
-
-    virtual ::Ice::ObjectPtr removeAdminFacet(const ::std::string&) = 0;
-
-    virtual ::Ice::ObjectPtr findAdminFacet(const ::std::string&) = 0;
-
-    virtual ::Ice::FacetMap findAllAdminFacets() = 0;
+    /**
+     * Shuts down this communicator's server functionality, which
+     * includes the deactivation of all object adapters. Attempts to use a
+     * deactivated object adapter raise ObjectAdapterDeactivatedException.
+     * Subsequent calls to shutdown are ignored.
+     *
+     * After shutdown returns, no new requests are processed. However, requests
+     * that have been started before shutdown was called might still be active.
+     * You can use {@link #waitForShutdown} to wait for the completion of all
+     * requests.
+     * @see #destroy
+     * @see #waitForShutdown
+     * @see ObjectAdapter#deactivate
+     */
+    virtual void shutdown() ICE_NOEXCEPT = 0;
+
+    /**
+     * Wait until the application has called {@link #shutdown} (or {@link #destroy}).
+     * On the server side, this operation blocks the calling thread
+     * until all currently-executing operations have completed.
+     * On the client side, the operation simply blocks until another
+     * thread has called {@link #shutdown} or {@link #destroy}.
+     *
+     * A typical use of this operation is to call it from the main thread,
+     * which then waits until some other thread calls {@link #shutdown}.
+     * After shut-down is complete, the main thread returns and can do some
+     * cleanup work before it finally calls {@link #destroy} to shut down
+     * the client functionality, and then exits the application.
+     * @see #shutdown
+     * @see #destroy
+     * @see ObjectAdapter#waitForDeactivate
+     */
+    virtual void waitForShutdown() ICE_NOEXCEPT = 0;
+
+    /**
+     * Check whether communicator has been shut down.
+     * @return True if the communicator has been shut down; false otherwise.
+     * @see #shutdown
+     */
+    virtual bool isShutdown() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Convert a stringified proxy into a proxy. For example,
+     * <tt>MyCategory/MyObject:tcp -h some_host -p
+     * 10000</tt> creates a proxy that refers to the Ice object
+     * having an identity with a name "MyObject" and a category
+     * "MyCategory", with the server running on host "some_host", port
+     * 10000. If the stringified proxy does not parse correctly, the
+     * operation throws one of ProxyParseException, EndpointParseException,
+     * or IdentityParseException. Refer to the Ice manual for a detailed
+     * description of the syntax supported by stringified proxies.
+     * @param str The stringified proxy to convert into a proxy.
+     * @return The proxy, or nil if <tt>str</tt> is an empty string.
+     * @see #proxyToString
+     */
+    virtual ObjectPrx stringToProxy(const ::std::string& str) const = 0;
+
+    /**
+     * Convert a proxy into a string.
+     * @param obj The proxy to convert into a stringified proxy.
+     * @return The stringified proxy, or an empty string if
+     * <tt>obj</tt> is nil.
+     * @see #stringToProxy
+     */
+    virtual ::std::string proxyToString(const ObjectPrx& obj) const = 0;
+
+    /**
+     * Convert a set of proxy properties into a proxy. The "base"
+     * name supplied in the <tt>property</tt> argument refers to a
+     * property containing a stringified proxy, such as
+     * <tt>MyProxy=id:tcp -h localhost -p 10000</tt>. Additional
+     * properties configure local settings for the proxy, such as
+     * <tt>MyProxy.PreferSecure=1</tt>. The "Properties"
+     * appendix in the Ice manual describes each of the supported
+     * proxy properties.
+     * @param property The base property name.
+     * @return The proxy.
+     */
+    virtual ObjectPrx propertyToProxy(const ::std::string& property) const = 0;
+
+    /**
+     * Convert a proxy to a set of proxy properties.
+     * @param proxy The proxy.
+     * @param property The base property name.
+     * @return The property set.
+     */
+    virtual PropertyDict proxyToProperty(const ObjectPrx& proxy, const ::std::string& property) const = 0;
+
+    /**
+     * Convert a string into an identity. If the string does not parse
+     * correctly, the operation throws IdentityParseException.
+     * @param str The string to convert into an identity.
+     * @return The identity.
+     * @see #identityToString
+     *
+     * @deprecated stringToIdentity() is deprecated, use the static stringToIdentity() method instead.
+     */
+    ICE_DEPRECATED_API("stringToIdentity() is deprecated, use the static stringToIdentity() method instead.") virtual Identity stringToIdentity(const ::std::string& str) const = 0;
+
+    /**
+     * Convert an identity into a string.
+     * @param ident The identity to convert into a string.
+     * @return The "stringified" identity.
+     * @see #stringToIdentity
+     */
+    virtual ::std::string identityToString(const Identity& ident) const = 0;
+
+    /**
+     * Create a new object adapter. The endpoints for the object
+     * adapter are taken from the property <tt><em>name</em>.Endpoints</tt>.
+     *
+     * It is legal to create an object adapter with the empty string as
+     * its name. Such an object adapter is accessible via bidirectional
+     * connections or by collocated invocations that originate from the
+     * same communicator as is used by the adapter.
+     *
+     * Attempts to create a named object adapter for which no configuration
+     * can be found raise InitializationException.
+     * @param name The object adapter name.
+     * @return The new object adapter.
+     * @see #createObjectAdapterWithEndpoints
+     * @see ObjectAdapter
+     * @see Properties
+     */
+    virtual ObjectAdapterPtr createObjectAdapter(const ::std::string& name) = 0;
+
+    /**
+     * Create a new object adapter with endpoints. This operation sets
+     * the property <tt><em>name</em>.Endpoints</tt>, and then calls
+     * {@link #createObjectAdapter}. It is provided as a convenience
+     * function.
+     *
+     * Calling this operation with an empty name will result in a
+     * UUID being generated for the name.
+     * @param name The object adapter name.
+     * @param endpoints The endpoints for the object adapter.
+     * @return The new object adapter.
+     * @see #createObjectAdapter
+     * @see ObjectAdapter
+     * @see Properties
+     */
+    virtual ObjectAdapterPtr createObjectAdapterWithEndpoints(const ::std::string& name, const ::std::string& endpoints) = 0;
+
+    /**
+     * Create a new object adapter with a router. This operation
+     * creates a routed object adapter.
+     *
+     * Calling this operation with an empty name will result in a
+     * UUID being generated for the name.
+     * @param name The object adapter name.
+     * @param rtr The router.
+     * @return The new object adapter.
+     * @see #createObjectAdapter
+     * @see ObjectAdapter
+     * @see Properties
+     */
+    virtual ObjectAdapterPtr createObjectAdapterWithRouter(const ::std::string& name, const RouterPrx& rtr) = 0;
+
+    /**
+     * Add an object factory to this communicator. Installing a
+     * factory with an id for which a factory is already registered
+     * throws AlreadyRegisteredException.
+     *
+     * When unmarshaling an Ice object, the Ice run time reads the
+     * most-derived type id off the wire and attempts to create an
+     * instance of the type using a factory. If no instance is created,
+     * either because no factory was found, or because all factories
+     * returned nil, the behavior of the Ice run time depends on the
+     * format with which the object was marshaled:
+     *
+     * If the object uses the "sliced" format, Ice ascends the class
+     * hierarchy until it finds a type that is recognized by a factory,
+     * or it reaches the least-derived type. If no factory is found that
+     * can create an instance, the run time throws NoValueFactoryException.
+     *
+     * If the object uses the "compact" format, Ice immediately raises
+     * NoValueFactoryException.
+     *
+     * The following order is used to locate a factory for a type:
+     *
+     * <ol>
+     *
+     * <li>The Ice run-time looks for a factory registered
+     * specifically for the type.</li>
+     *
+     * <li>If no instance has been created, the Ice run-time looks
+     * for the default factory, which is registered with an empty type id.
+     * </li>
+     *
+     * <li>If no instance has been created by any of the preceding
+     * steps, the Ice run-time looks for a factory that may have been
+     * statically generated by the language mapping for non-abstract classes.
+     * </li>
+     *
+     * </ol>
+     * @param factory The factory to add.
+     * @param id The type id for which the factory can create instances, or
+     * an empty string for the default factory.
+     * @see #findObjectFactory
+     * @see ObjectFactory
+     * @see ValueFactoryManager#add
+     *
+     * @deprecated addObjectFactory() is deprecated, use ValueFactoryManager::add() instead.
+     */
+    ICE_DEPRECATED_API("addObjectFactory() is deprecated, use ValueFactoryManager::add() instead.") virtual void addObjectFactory(const ObjectFactoryPtr& factory, const ::std::string& id) = 0;
+
+    /**
+     * Find an object factory registered with this communicator.
+     * @param id The type id for which the factory can create instances,
+     * or an empty string for the default factory.
+     * @return The object factory, or null if no object factory was
+     * found for the given id.
+     * @see #addObjectFactory
+     * @see ObjectFactory
+     * @see ValueFactoryManager#find
+     *
+     * @deprecated findObjectFactory() is deprecated, use ValueFactoryManager::find() instead.
+     */
+    ICE_DEPRECATED_API("findObjectFactory() is deprecated, use ValueFactoryManager::find() instead.") virtual ObjectFactoryPtr findObjectFactory(const ::std::string& id) const ICE_NOEXCEPT = 0;
+
+    /**
+     * Get the implicit context associated with this communicator.
+     * @return The implicit context associated with this communicator;
+     * returns null when the property Ice.ImplicitContext is not set
+     * or is set to None.
+     */
+    virtual ImplicitContextPtr getImplicitContext() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Get the properties for this communicator.
+     * @return This communicator's properties.
+     * @see Properties
+     */
+    virtual PropertiesPtr getProperties() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Get the logger for this communicator.
+     * @return This communicator's logger.
+     * @see Logger
+     */
+    virtual LoggerPtr getLogger() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Get the observer resolver object for this communicator.
+     * @return This communicator's observer resolver object.
+     */
+    virtual Instrumentation::CommunicatorObserverPtr getObserver() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Get the default router this communicator.
+     * @return The default router for this communicator.
+     * @see #setDefaultRouter
+     * @see Router
+     */
+    virtual RouterPrx getDefaultRouter() const = 0;
+
+    /**
+     * Set a default router for this communicator. All newly
+     * created proxies will use this default router. To disable the
+     * default router, null can be used. Note that this
+     * operation has no effect on existing proxies.
+     *
+     * You can also set a router for an individual proxy
+     * by calling the operation <tt>ice_router</tt> on the proxy.
+     * @param rtr The default router to use for this communicator.
+     * @see #getDefaultRouter
+     * @see #createObjectAdapterWithRouter
+     * @see Router
+     */
+    virtual void setDefaultRouter(const RouterPrx& rtr) = 0;
+
+    /**
+     * Get the default locator this communicator.
+     * @return The default locator for this communicator.
+     * @see #setDefaultLocator
+     * @see Locator
+     */
+    virtual LocatorPrx getDefaultLocator() const = 0;
+
+    /**
+     * Set a default Ice locator for this communicator. All newly
+     * created proxy and object adapters will use this default
+     * locator. To disable the default locator, null can be used.
+     * Note that this operation has no effect on existing proxies or
+     * object adapters.
+     *
+     * You can also set a locator for an individual proxy by calling the
+     * operation <tt>ice_locator</tt> on the proxy, or for an object adapter
+     * by calling {@link ObjectAdapter#setLocator} on the object adapter.
+     * @param loc The default locator to use for this communicator.
+     * @see #getDefaultLocator
+     * @see Locator
+     * @see ObjectAdapter#setLocator
+     */
+    virtual void setDefaultLocator(const LocatorPrx& loc) = 0;
+
+    /**
+     * Get the plug-in manager for this communicator.
+     * @return This communicator's plug-in manager.
+     * @see PluginManager
+     */
+    virtual PluginManagerPtr getPluginManager() const = 0;
+
+    /**
+     * Get the value factory manager for this communicator.
+     * @return This communicator's value factory manager.
+     * @see ValueFactoryManager
+     */
+    virtual ValueFactoryManagerPtr getValueFactoryManager() const ICE_NOEXCEPT = 0;
+
+    /**
+     * Flush any pending batch requests for this communicator.
+     * This means all batch requests invoked on fixed proxies
+     * for all connections associated with the communicator.
+     * Any errors that occur while flushing a connection are ignored.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     */
+    virtual void flushBatchRequests(CompressBatch compress) = 0;
+
+    /**
+     * Flush any pending batch requests for this communicator.
+     * This means all batch requests invoked on fixed proxies
+     * for all connections associated with the communicator.
+     * Any errors that occur while flushing a connection are ignored.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     * @return The asynchronous result object for the invocation.
+     */
+    virtual AsyncResultPtr begin_flushBatchRequests(CompressBatch compress) = 0;
+
+    /**
+     * Flush any pending batch requests for this communicator.
+     * This means all batch requests invoked on fixed proxies
+     * for all connections associated with the communicator.
+     * Any errors that occur while flushing a connection are ignored.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     * @param cb Callback to be invoked when the invocation completes
+     * @param cookie Extra data to associate with the invocation.
+     * @return The asynchronous result object for the invocation.
+     */
+    virtual AsyncResultPtr begin_flushBatchRequests(CompressBatch compress, const CallbackPtr& cb, const LocalObjectPtr& cookie = 0) = 0;
+
+    /**
+     * Flush any pending batch requests for this communicator.
+     * This means all batch requests invoked on fixed proxies
+     * for all connections associated with the communicator.
+     * Any errors that occur while flushing a connection are ignored.
+     * @param compress Specifies whether or not the queued batch requests
+     * should be compressed before being sent over the wire.
+     * @param cb Callback to be invoked when the invocation completes
+     * @param cookie Extra data to associate with the invocation.
+     * @return The asynchronous result object for the invocation.
+     */
+    virtual AsyncResultPtr begin_flushBatchRequests(CompressBatch compress, const Callback_Communicator_flushBatchRequestsPtr& cb, const LocalObjectPtr& cookie = 0) = 0;
+
+    /**
+     * Flush any pending batch requests for this communicator.
+     * This means all batch requests invoked on fixed proxies
+     * for all connections associated with the communicator.
+     * Any errors that occur while flushing a connection are ignored.
+     * @param result The asynchronous result object returned by the begin_ method.
+     */
+    virtual void end_flushBatchRequests(const AsyncResultPtr& result) = 0;
+
+    /**
+     * Add the Admin object with all its facets to the provided object adapter.
+     * If Ice.Admin.ServerId is set and the provided object adapter has a {@link Locator},
+     * createAdmin registers the Admin's Process facet with the {@link Locator}'s {@link LocatorRegistry}.
+     *
+     * createAdmin call only be called once; subsequent calls raise InitializationException.
+     * @param adminAdapter The object adapter used to host the Admin object; if null and
+     * Ice.Admin.Endpoints is set, create, activate and use the Ice.Admin object adapter.
+     * @param adminId The identity of the Admin object.
+     * @return A proxy to the main ("") facet of the Admin object. Never returns a null proxy.
+     * @see #getAdmin
+     */
+    virtual ObjectPrx createAdmin(const ObjectAdapterPtr& adminAdapter, const Identity& adminId) = 0;
+
+    /**
+     * Get a proxy to the main facet of the Admin object.
+     *
+     * getAdmin also creates the Admin object and creates and activates the Ice.Admin object
+     * adapter to host this Admin object if Ice.Admin.Enpoints is set. The identity of the Admin
+     * object created by getAdmin is {value of Ice.Admin.InstanceName}/admin, or {UUID}/admin
+     * when Ice.Admin.InstanceName is not set.
+     *
+     * If Ice.Admin.DelayCreation is 0 or not set, getAdmin is called by the communicator
+     * initialization, after initialization of all plugins.
+     * @return A proxy to the main ("") facet of the Admin object, or a null proxy if no
+     * Admin object is configured.
+     * @see #createAdmin
+     */
+    virtual ObjectPrx getAdmin() const = 0;
+
+    /**
+     * Add a new facet to the Admin object.
+     * Adding a servant with a facet that is already registered
+     * throws AlreadyRegisteredException.
+     * @param servant The servant that implements the new Admin facet.
+     * @param facet The name of the new Admin facet.
+     */
+    virtual void addAdminFacet(const ObjectPtr& servant, const ::std::string& facet) = 0;
+
+    /**
+     * Remove the following facet to the Admin object.
+     * Removing a facet that was not previously registered throws
+     * NotRegisteredException.
+     * @param facet The name of the Admin facet.
+     * @return The servant associated with this Admin facet.
+     */
+    virtual ObjectPtr removeAdminFacet(const ::std::string& facet) = 0;
+
+    /**
+     * Returns a facet of the Admin object.
+     * @param facet The name of the Admin facet.
+     * @return The servant associated with this Admin facet, or
+     * null if no facet is registered with the given name.
+     */
+    virtual ObjectPtr findAdminFacet(const ::std::string& facet) = 0;
+
+    /**
+     * Returns a map of all facets of the Admin object.
+     * @return A collection containing all the facet names and
+     * servants of the Admin object.
+     * @see #findAdminFacet
+     */
+    virtual FacetMap findAllAdminFacets() = 0;
 };
 
+/// \cond INTERNAL
 inline bool operator==(const Communicator& lhs, const Communicator& 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 Communicator& lhs, const Communicator& 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