Skip to content

Commit

Permalink
Minor comment fixes. (#3196)
Browse files Browse the repository at this point in the history
  • Loading branch information
InsertCreativityHere authored Nov 26, 2024
1 parent 0288df0 commit 8ea1dd2
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion cpp/include/Ice/IncomingRequest.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ namespace Ice
class InputStream;

/**
* Represent a request received by a connection. It's the argument to the dispatch function on Object.
* Represents a request received by a connection. It's the argument to the dispatch function on Object.
* @remarks IncomingRequest is neither copyable nor movable. It can be used only on the dispatch thread.
* @see Object::dispatch
* \headerfile Ice/Ice.h
Expand Down
4 changes: 2 additions & 2 deletions cpp/include/Ice/OutgoingResponse.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
namespace Ice
{
/**
* Represent the status of a response.
* Represents the status of a response.
* \headerfile Ice/Ice.h
*/
enum class ReplyStatus : std::uint8_t
Expand All @@ -30,7 +30,7 @@ namespace Ice
};

/**
* Represent the response to an incoming request. It's the argument to the sendResponse callback accepted by
* Represents the response to an incoming request. It's the argument to the sendResponse callback accepted by
* Object::dispatch.
* @remarks OutgoingResponse is movable but not copyable. sendResponse wrappers must move the response to the next
* callback.
Expand Down
2 changes: 1 addition & 1 deletion cpp/test/Slice/errorDetection/ConstDef.ice
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ const string nullstring4 = "a\U00000000"; // OK
const byte c1 = l1; // OK
const short c2 = l1; // OK
const int c3 = l1; // OK
const long c4 = l1; // OK
const long c4 = l1; // OK

const byte c5 = s2; // overflow
const short c6 = i2; // overflow
Expand Down
2 changes: 1 addition & 1 deletion slice/Ice/EndpointTypes.ice
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module Ice
/// Uniquely identifies TCP-based WebSocket endpoints.
const short WSEndpointType = 4;

/// Uniquely identifies SSL-based WebSocket endpoints.
/// Uniquely identifies SSL-based WebSocket endpoints.
const short WSSEndpointType = 5;

/// Uniquely identifies Bluetooth endpoints.
Expand Down
4 changes: 2 additions & 2 deletions slice/Ice/Locator.ice
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ module Ice
{
interface Process;

/// This exception is raised if an adapter cannot be found.
/// This exception is raised if an adapter cannot be found.
exception AdapterNotFoundException
{
}
Expand Down Expand Up @@ -113,7 +113,7 @@ module Ice
}

/// This interface should be implemented by services implementing the <code>Ice::Locator interface</code>. It should
/// be advertised through an Ice object with the identity <code>`Ice/LocatorFinder'</code>. This allows clients to
/// be advertised through an Ice object with the identity <code>'Ice/LocatorFinder'</code>. This allows clients to
/// retrieve the locator proxy with just the endpoint information of the service.
interface LocatorFinder
{
Expand Down
2 changes: 1 addition & 1 deletion slice/Ice/Router.ice
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ module Ice
}

/// This interface should be implemented by services implementing the Ice::Router interface. It should be advertised
/// through an Ice object with the identity `Ice/RouterFinder'. This allows clients to retrieve the router proxy
/// through an Ice object with the identity 'Ice/RouterFinder'. This allows clients to retrieve the router proxy
/// with just the endpoint information of the service.
interface RouterFinder
{
Expand Down
2 changes: 1 addition & 1 deletion slice/IceGrid/Admin.ice
Original file line number Diff line number Diff line change
Expand Up @@ -846,7 +846,7 @@ module IceGrid
/// If 0 or positive, the file is read from the last <code>count</code> lines.
/// @return An iterator to read the file. The returned proxy is never null.
/// @throws FileNotAvailableException Raised if the file can't be read.
/// @throws ServerNotExistException Raised if the server doesn't exist.
/// @throws ServerNotExistException Raised if the server doesn't exist.
/// @throws NodeUnreachableException Raised if the node could not be reached.
/// @throws DeploymentException Raised if the server couldn't be deployed on the node.
FileIterator* openServerStdOut(string id, int count)
Expand Down
2 changes: 1 addition & 1 deletion slice/IceLocatorDiscovery/IceLocatorDiscovery.ice
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ module IceLocatorDiscovery

/// The Ice lookup interface is implemented by Ice locator implementations and can be used by clients to find
/// available Ice locators on the network.
/// Ice locator implementations provide a well-known `Ice/LocatorLookup' object accessible through UDP multicast.
/// Ice locator implementations provide a well-known 'Ice/LocatorLookup' object accessible through UDP multicast.
/// Clients typically make a multicast findLocator request to find the locator proxy.
/// @see LookupReply
interface Lookup
Expand Down
10 changes: 5 additions & 5 deletions slice/IceStorm/IceStorm.ice
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module IceStorm

interface Topic;

/// Information on the topic links.
/// Information on the topic links.
struct LinkInfo
{
/// The linked topic. It is never null.
Expand Down Expand Up @@ -61,7 +61,7 @@ exception NoSuchLink
string name;
}

/// This exception indicates that an attempt was made to subscribe a proxy for which a subscription already exists.
/// This exception indicates that an attempt was made to subscribe a proxy for which a subscription already exists.
exception AlreadySubscribed
{
}
Expand All @@ -80,7 +80,7 @@ exception BadQoS
string reason;
}

/// Publishers publish information on a particular topic. A topic logically represents a type. A
/// Publishers publish information on a particular topic. A topic logically represents a type.
/// @see TopicManager
interface Topic
{
Expand All @@ -101,7 +101,7 @@ interface Topic
/// @return A proxy to publish data on this topic.
["cpp:const"] idempotent Object* getNonReplicatedPublisher();

/// Subscribe with the given <code>qos</code> to this topic. A per-subscriber publisher object is returned.
/// Subscribe with the given <code>qos</code> to this topic. A per-subscriber publisher object is returned.
/// @param theQoS The quality of service parameters for this subscription.
/// @param subscriber The subscriber's proxy. This proxy is never null.
/// @return The per-subscriber publisher object. The returned object is never null.
Expand Down Expand Up @@ -179,7 +179,7 @@ interface TopicManager
idempotent TopicDict retrieveAll();
}

/// This interface is advertised by the IceStorm service through the Ice object with the identity `IceStorm/Finder'.
/// This interface is advertised by the IceStorm service through the Ice object with the identity 'IceStorm/Finder'.
/// This allows clients to retrieve the topic manager with just the endpoint information of the IceStorm service.
interface Finder
{
Expand Down

0 comments on commit 8ea1dd2

Please sign in to comment.