diff options
author | Michi Henning <michi@zeroc.com> | 2006-12-20 07:03:32 +0000 |
---|---|---|
committer | Michi Henning <michi@zeroc.com> | 2006-12-20 07:03:32 +0000 |
commit | 10ca9874264bdc856a2a7ac3d059f9a55e2f720d (patch) | |
tree | 8f2ea33742f61b3370e8dbbb0a3d7ea432fdde54 /cpp | |
parent | Added missing doc comment. (diff) | |
download | ice-10ca9874264bdc856a2a7ac3d059f9a55e2f720d.tar.bz2 ice-10ca9874264bdc856a2a7ac3d059f9a55e2f720d.tar.xz ice-10ca9874264bdc856a2a7ac3d059f9a55e2f720d.zip |
More slice2html changes.
Diffstat (limited to 'cpp')
-rw-r--r-- | cpp/include/IceUtil/OutputUtil.h | 2 | ||||
-rw-r--r-- | cpp/slice/Ice/Communicator.ice | 29 | ||||
-rw-r--r-- | cpp/slice/Ice/ImplicitContext.ice | 5 | ||||
-rw-r--r-- | cpp/slice/Ice/Locator.ice | 8 | ||||
-rw-r--r-- | cpp/slice/Ice/ObjectAdapter.ice | 24 | ||||
-rw-r--r-- | cpp/slice/Ice/ObjectFactory.ice | 2 | ||||
-rw-r--r-- | cpp/slice/Ice/Process.ice | 4 | ||||
-rw-r--r-- | cpp/slice/Ice/Router.ice | 4 | ||||
-rw-r--r-- | cpp/slice/Ice/ServantLocator.ice | 9 | ||||
-rw-r--r-- | cpp/slice/IceBox/IceBox.ice | 4 | ||||
-rw-r--r-- | cpp/slice/IceGrid/Admin.ice | 7 | ||||
-rw-r--r-- | cpp/src/IceUtil/OutputUtil.cpp | 21 | ||||
-rw-r--r-- | cpp/src/slice2docbook/Gen.cpp | 1 | ||||
-rw-r--r-- | cpp/src/slice2html/Gen.cpp | 24 |
14 files changed, 61 insertions, 83 deletions
diff --git a/cpp/include/IceUtil/OutputUtil.h b/cpp/include/IceUtil/OutputUtil.h index 640b6cf2827..bb091eedb50 100644 --- a/cpp/include/IceUtil/OutputUtil.h +++ b/cpp/include/IceUtil/OutputUtil.h @@ -234,7 +234,6 @@ public: XMLOutput(std::ostream&); XMLOutput(const char*); - void setSGML(bool); virtual void print(const char*); // Print a string. virtual void newline(); // Print newline. @@ -257,7 +256,6 @@ private: bool _se; bool _text; - bool _sgml; bool _escape; }; diff --git a/cpp/slice/Ice/Communicator.ice b/cpp/slice/Ice/Communicator.ice index 2b4e549af9c..1c92ee6dba0 100644 --- a/cpp/slice/Ice/Communicator.ice +++ b/cpp/slice/Ice/Communicator.ice @@ -37,7 +37,7 @@ module 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. + * is language-specific, and not specified in Slice code. * * @see Logger * @see Stats @@ -65,13 +65,13 @@ local interface Communicator * Shuts down this communicator's server functionality, including * the deactivation of all object adapters. (Attempts to use * a deactivated object adapter raise [ObjectAdapterDeactivatedException].) - * Subsequent calls to [shutdown] are ignored. + * Subsequent calls to [shutdown] are ignored.</p> * * <p class="Note"> 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 * [waitForShutdown] to wait for the completion of all - * requests.</p> + * requests. * * @see destroy * @see waitForShutdown @@ -192,13 +192,13 @@ local interface Communicator * the property * <tt><em>name</em>.Endpoints</tt>, * and then calls [createObjectAdapter]. It is provided as a - * convenience function. + * convenience function.</p> * * <p>It is legal to create an object adapter without any endpoints. * Such an object adapter cannot be accessed remotely and, therefore, * is accessible only for collocated invocations that originate from the * the same communicator as is used by the adapter. - * space.</p> + * space. * * @param name The object adapter name. * @@ -243,7 +243,7 @@ local interface Communicator * either because no factory was found, or because all factories * returned nil, the object is sliced to the next most-derived type * and the process repeats. If no factory is found that can create an - * instance, the Ice run-time throws [NoObjectFactoryException].</dd> + * instance, the Ice run-time throws [NoObjectFactoryException].</p> * * <p>The following order is used to locate a factory for a type:</p> * @@ -262,6 +262,7 @@ local interface Communicator * </li> * * </ol> + * <p> * * @param factory The factory to add. * @@ -307,10 +308,10 @@ local interface Communicator * * Set a default context on this communicator. All newly * created proxies will use this default context. This operation - * has no effect on existing proxies. + * has no effect on existing proxies.</p> * * <p class="Note"> You can also set a context for an individual proxy - * by calling the operation [ice_context] on the proxy.</p> + * by calling the operation [ice_context] on the proxy. * * @param ctx The default context to be set. * @see getDefaultContext @@ -377,10 +378,10 @@ local interface Communicator * 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. + * operation has no effect on existing proxies.</p> * - * <note><p> You can also set a router for an individual proxy - * by calling the operation [ice_router] on the proxy.</p></note> + * <p class="Note">You can also set a router for an individual proxy + * by calling the operation [ice_router] on the proxy. * * @param rtr The default router to use for this communicator. * @@ -409,12 +410,12 @@ local interface Communicator * 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. + * object adapters.</p> * - * <note><p> You can also set a locator for an individual proxy + * <p class="Note"> You can also set a locator for an individual proxy * by calling the operation [ice_locator] on the proxy, or for an * object adapter by calling the operation [setLocator] on the - * object adapter.</p></note> + * object adapter. * * @param loc The default locator to use for this communicator. * diff --git a/cpp/slice/Ice/ImplicitContext.ice b/cpp/slice/Ice/ImplicitContext.ice index 00f7ee0b06b..beb5143e5d6 100644 --- a/cpp/slice/Ice/ImplicitContext.ice +++ b/cpp/slice/Ice/ImplicitContext.ice @@ -20,8 +20,8 @@ module Ice * * When you make a remote invocation without an explicit [Context] parameter, * Ice uses the per-proxy [Context] (if any) combined with the [ImplicitContext] - * associated with the communicator.</p> - * <p>Ice provides several implementations of [ImplicitContext]. The implementation + * associated with the communicator.</dd> + * <dd>Ice provides several implementations of [ImplicitContext]. The implementation * used depends on the value of the Ice.ImplicitContext property. * <dl> * <dt>None (default)</dt> @@ -36,6 +36,7 @@ module Ice * [Context] shared by all threads, and does not serialize access to this [Context].</dd> * </dt> * </dl> + * </dd> * **/ diff --git a/cpp/slice/Ice/Locator.ice b/cpp/slice/Ice/Locator.ice index 188ceaaf924..a03e88711c6 100644 --- a/cpp/slice/Ice/Locator.ice +++ b/cpp/slice/Ice/Locator.ice @@ -71,10 +71,10 @@ interface LocatorRegistry; * lookup adapters and objects. It is also used by servers to get the * locator registry proxy. * - * <note><p> The [Locator] interface is intended to be used by + * <p class="Note"> The [Locator] interface is intended to be used by * Ice internals and by locator implementations. Regular user code * should not attempt to use any functionality of this interface - * directly.</p></note> + * directly.</p> * **/ interface Locator @@ -125,10 +125,10 @@ interface Locator * The Ice locator registry interface. This interface is used by * servers to register adapter endpoints with the locator. * - * <note><p> The [LocatorRegistry] interface is intended to be used + * <p class="Note"> The [LocatorRegistry] interface is intended to be used * by Ice internals and by locator implementations. Regular user * code should not attempt to use any functionality of this interface - * directly.</p></note> + * directly.</p> * **/ interface LocatorRegistry diff --git a/cpp/slice/Ice/ObjectAdapter.ice b/cpp/slice/Ice/ObjectAdapter.ice index d85b80d7c76..08b2f781ad4 100644 --- a/cpp/slice/Ice/ObjectAdapter.ice +++ b/cpp/slice/Ice/ObjectAdapter.ice @@ -69,10 +69,10 @@ local interface ObjectAdapter * Temporarily hold receiving and dispatching requests. The object * adapter can be reactivated with the [activate] operation. * - * <note><p> Holding is not immediate, i.e., after [hold] + * <p class="Note"> Holding is not immediate, i.e., after [hold] * returns, the object adapter might still be active for some * time. You can use [waitForHold] to wait until holding is - * complete. </p></note> + * complete.</p> * * @see activate * @see deactivate @@ -105,12 +105,12 @@ local interface ObjectAdapter * [deactivate] an already deactivated object adapter are ignored * and do nothing. * - * <note><p> After [deactivate] returns, no new requests are + * <p class="Note"> After [deactivate] returns, no new requests are * processed by the object adapter. However, requests that have * been started before [deactivate] was called might still be * active. You can use [waitForDeactivate] to wait for the * completion of all requests for this object - * adapter. </p></note> + * adapter.</p> * * @see activate * @see hold @@ -295,9 +295,9 @@ local interface ObjectAdapter * Look up a servant in this object adapter's Active Servant Map * by the identity of the Ice object it implements. * - * <note><p>This operation only tries to lookup a servant in + * <p class="Note">This operation only tries to lookup a servant in * the Active Servant Map. It does not attempt to find a servant - * by using any installed [ServantLocator].</p></note> + * by using any installed [ServantLocator].</p> * * @param id The identity of the Ice object for which the * servant should be returned. @@ -358,9 +358,9 @@ local interface ObjectAdapter * Look up a servant in this object adapter's Active Servant Map, * given a proxy. * - * <note><p>This operation only tries to lookup a servant in + * <p class="Note">This operation only tries to lookup a servant in * the Active Servant Map. It does not attempt to find a servant - * via any installed [ServantLocator]s.</p></note> + * via any installed [ServantLocator]s.</p> * * @param proxy The proxy for which the servant should be returned. * @@ -407,8 +407,8 @@ local interface ObjectAdapter * * </ol> * - * <note><p>Only one locator for the empty category can be - * installed.</p></note> + * <p class="Note">Only one locator for the empty category can be + * installed.</p> * * @param locator The locator to add. * @@ -497,9 +497,9 @@ local interface ObjectAdapter * A reverse proxy uses the incoming connections that have been * established from a client to this object adapter. * - * <note><p> This operation is intended to be used by special + * <p class="Note"> This operation is intended to be used by special * services, such as [Router] implementations. Regular user code - * should not attempt to use this operation. </p></note> + * should not attempt to use this operation.</p> * * @param id The identity for which a proxy is to be created. * diff --git a/cpp/slice/Ice/ObjectFactory.ice b/cpp/slice/Ice/ObjectFactory.ice index ed9d87207da..0f14ef2970e 100644 --- a/cpp/slice/Ice/ObjectFactory.ice +++ b/cpp/slice/Ice/ObjectFactory.ice @@ -34,7 +34,7 @@ local interface ObjectFactory * Slice type id for interfaces of type [Bar] in the module * [Foo] is [::Foo::Bar]. * - * <note><p>The leading "[::]" is required.</p></note> + * <p class="Note">The leading "[::]" is required.</p> * * @param type The object type. * diff --git a/cpp/slice/Ice/Process.ice b/cpp/slice/Ice/Process.ice index 805f2529d92..a034d4cc343 100644 --- a/cpp/slice/Ice/Process.ice +++ b/cpp/slice/Ice/Process.ice @@ -18,11 +18,11 @@ module Ice * An administrative interface for process management. Managed servers must * implement this interface. * - * <note><p> A servant implementing this interface is a potential target + * <p class="Note">A servant implementing this interface is a potential target * for denial-of-service attacks, therefore proper security precautions * should be taken. For example, the servant can use a UUID to make its * identity harder to guess, and be registered in an object adapter with - * a secured endpoint.</p></note> + * a secured endpoint.</p> * **/ interface Process diff --git a/cpp/slice/Ice/Router.ice b/cpp/slice/Ice/Router.ice index 2ffa0b220c8..a939d44fd8b 100644 --- a/cpp/slice/Ice/Router.ice +++ b/cpp/slice/Ice/Router.ice @@ -48,8 +48,8 @@ interface Router * * Add new proxy information to the router's routing table. * - * <note><p>This operation is deprecated, and only used for old - * Ice clients (older than version 3.1).</p></note> + * <p class="Note">This operation is deprecated, and only used for old + * Ice clients (older than version 3.1).</p> * * @param proxy The proxy to add. * diff --git a/cpp/slice/Ice/ServantLocator.ice b/cpp/slice/Ice/ServantLocator.ice index 5f2938ed4a3..d1b3a2ac8ce 100644 --- a/cpp/slice/Ice/ServantLocator.ice +++ b/cpp/slice/Ice/ServantLocator.ice @@ -36,12 +36,11 @@ local interface ServantLocator * the returned servant into its active servant map. This must be * done by the servant locator implementation, if this is desired. * - * <important><p>If you call [locate] from your own code, you + * <p class="Note">If you call [locate] from your own code, you * must also call [finished] when you have finished using the - * servant, provided that a non-null servant was - * returned. Otherwise you will get undefined behavior if you use - * Servant Locators such as the - * [Freeze::Evictor].</p></important> + * servant, provided that [locate] returned a non-null servant; + * otherwise, you will get undefined behavior if you use + * servant locators such as the [Freeze::Evictor].</p> * * @param curr Information about the current operation for which * a servant is required. diff --git a/cpp/slice/IceBox/IceBox.ice b/cpp/slice/IceBox/IceBox.ice index 9c70a582610..8fd488adb1c 100644 --- a/cpp/slice/IceBox/IceBox.ice +++ b/cpp/slice/IceBox/IceBox.ice @@ -85,8 +85,8 @@ local interface Service * also be used by other services, depending on the service * configuration. * - * <note><p>The [ServiceManager] owns this communicator, and is - * responsible for destroying it.</p></note> + * <p class="Note">The [ServiceManager] owns this communicator, and is + * responsible for destroying it.</p> * * @param name The service's name, as determined by the * configuration. diff --git a/cpp/slice/IceGrid/Admin.ice b/cpp/slice/IceGrid/Admin.ice index 58328659127..7351039e7b7 100644 --- a/cpp/slice/IceGrid/Admin.ice +++ b/cpp/slice/IceGrid/Admin.ice @@ -360,9 +360,10 @@ struct ApplicationUpdateInfo /** * - * The IceGrid administrative interface. <warning><p>Allowing - * access to this interface is a security risk! Please see the - * IceGrid documentation for further information.</p></warning> + * The IceGrid administrative interface. </p> + * <p class="Warning">Allowing access to this interface + * is a security risk! Please see the IceGrid documentation + * for further information. * **/ interface Admin diff --git a/cpp/src/IceUtil/OutputUtil.cpp b/cpp/src/IceUtil/OutputUtil.cpp index 2d674303f5d..b6cdf3fd533 100644 --- a/cpp/src/IceUtil/OutputUtil.cpp +++ b/cpp/src/IceUtil/OutputUtil.cpp @@ -312,7 +312,6 @@ IceUtil::XMLOutput::XMLOutput() : OutputBase(), _se(false), _text(false), - _sgml(false), _escape(false) { } @@ -321,7 +320,6 @@ IceUtil::XMLOutput::XMLOutput(ostream& os) : OutputBase(os), _se(false), _text(false), - _sgml(false), _escape(false) { } @@ -330,18 +328,11 @@ IceUtil::XMLOutput::XMLOutput(const char* s) : OutputBase(s), _se(false), _text(false), - _sgml(false), _escape(false) { } void -IceUtil::XMLOutput::setSGML(bool sgml) -{ - _sgml = true; -} - -void IceUtil::XMLOutput::print(const char* s) { if(_se) @@ -418,17 +409,7 @@ IceUtil::XMLOutput::endElement() dec(); if(_se) { - // - // SGML (docbook) doesn't support <foo/>. - // - if(_sgml) - { - _out << "></" << element << '>'; - } - else - { - _out << "/>"; - } + _out << "></" << element << '>'; } else { diff --git a/cpp/src/slice2docbook/Gen.cpp b/cpp/src/slice2docbook/Gen.cpp index 9a7cb1f497e..a37d0ea0255 100644 --- a/cpp/src/slice2docbook/Gen.cpp +++ b/cpp/src/slice2docbook/Gen.cpp @@ -40,7 +40,6 @@ Slice::Gen::Gen(const string& name, const string& file, bool standAlone, bool ch cerr << name << ": can't open `" << file << "' for writing: " << strerror(errno) << endl; return; } - O.setSGML(true); } Slice::Gen::~Gen() diff --git a/cpp/src/slice2html/Gen.cpp b/cpp/src/slice2html/Gen.cpp index 6f28b6164b2..33ef2d3fecd 100644 --- a/cpp/src/slice2html/Gen.cpp +++ b/cpp/src/slice2html/Gen.cpp @@ -294,7 +294,7 @@ Slice::GeneratorBase::printComment(const ContainedPtr& p, const string& deprecat if(!deprecateReason.empty()) { - start("p"); + start("p", "Deprecated"); _out << nl << deprecateReason; end(); } @@ -337,7 +337,7 @@ Slice::GeneratorBase::printComment(const ContainedPtr& p, const string& deprecat start("h4"); _out << "Return Value"; end(); - start("p", "Symbol"); + start("p"); _out << ret.front(); end(); } @@ -381,7 +381,7 @@ Slice::GeneratorBase::printComment(const ContainedPtr& p, const string& deprecat } if(!derivedClasses.empty()) { - start("h4", "Heading"); + start("h4"); _out << "Derived Classes and Interfaces"; end(); start("dl"); @@ -418,10 +418,10 @@ Slice::GeneratorBase::printComment(const ContainedPtr& p, const string& deprecat usedBy = p->unit()->findUsedBy(ex); if(!usedBy.empty()) { - start("h4", "Heading"); + start("h4"); _out << "Used By"; end(); - start("dl", "UsedBy"); + start("dl"); // // We first extract the symbol names from the used-by list and sort // them, otherwise the symbols appear in random order. @@ -473,10 +473,10 @@ Slice::GeneratorBase::printComment(const ContainedPtr& p, const string& deprecat strings.sort(); strings.unique(); - start("h4", "Heading"); + start("h4"); _out << "Used By"; end(); - start("dl", "UsedBy"); + start("dl"); for(list<string>::const_iterator p = strings.begin(); p != strings.end(); ++p) { start("dt", "Symbol"); @@ -491,7 +491,7 @@ Slice::GeneratorBase::printComment(const ContainedPtr& p, const string& deprecat start("h4"); _out << "See Also"; end(); - start("dl", "UsedBy"); + start("dl"); for(StringList::const_iterator q = see.begin(); q != see.end(); ++q) { start("dt", "Symbol"); @@ -540,9 +540,7 @@ Slice::GeneratorBase::printSummary(const ContainedPtr& p, const ContainerPtr& mo } string summary = getComment(p, container, true, module); - start("dd", "Summary"); _out << nl << summary; - end(); if(deprecated) { @@ -697,7 +695,7 @@ Slice::GeneratorBase::toString(const SyntaxTreeBasePtr& p, const ContainerPtr& c return s; } - string ret = "<a "; + string ret = "<a class=\"Symbol\" "; ret += (asTarget ? "name" : "href"); ret += "=\""; if(asTarget) @@ -1170,7 +1168,7 @@ Slice::IndexGenerator::~IndexGenerator() start("dl"); for(ModuleDescriptions::const_iterator i = _modules.begin(); i != _modules.end(); ++i) { - start("dt"); + start("dt", "Symbol"); _out << i->first; end(); start("dd"); @@ -1926,7 +1924,7 @@ Slice::StructGenerator::generate(const StructPtr& s) } } - start("h2", "Heading"); + start("h2"); _out << "Overview"; end(); |