Date: Friday, December 22, 2006 @ 11:21:07
Author: gilles
Path: /cvsroot/carob/carob/include
Modified: Connection.hpp (1.78 -> 1.79) ControllerInfo.hpp (1.5 -> 1.6)
SocketAddress.hpp (1.3 -> 1.4) StringCodecs.hpp (1.18 -> 1.19)
WatchedControllers.hpp (1.4 -> 1.5)
Javadoc fixes
------------------------+
Connection.hpp | 4 ++--
ControllerInfo.hpp | 2 +-
SocketAddress.hpp | 4 ++--
StringCodecs.hpp | 4 ++++
WatchedControllers.hpp | 2 +-
5 files changed, 10 insertions(+), 6 deletions(-)
Index: carob/include/Connection.hpp
diff -u carob/include/Connection.hpp:1.78 carob/include/Connection.hpp:1.79
--- carob/include/Connection.hpp:1.78 Wed Dec 20 17:32:49 2006
+++ carob/include/Connection.hpp Fri Dec 22 11:21:07 2006
@@ -391,7 +391,7 @@
/**
* This function should be used to establish a new connection to another
* controller in the list. It monitors "virtualdatabase not available"
- * failures by calling [EMAIL PROTECTED]
#connectToNextController(SequoiaUrl)} only a
+ * failures by calling [EMAIL PROTECTED] #connectToNextController()} only a
* limited number of times (number = number of available controllers).
*
* @throw AuthenticationException if the authentication has failed
@@ -431,7 +431,7 @@
UnexpectedException);
/**
* Reads the controller acknowledgements and misc parameters that finish
- * connection. To be called only by [EMAIL PROTECTED]
#initConnectionToNextController()}
+ * connection. To be called only by [EMAIL PROTECTED]
#connectToNextController()}
* @throw AuthenticationException if the controller did not acknowledge
* @throw SocketIOException in case of i/o error during finalization
* @throw VirtualDatabaseUnavailableException if the virtual database is not
Index: carob/include/ControllerInfo.hpp
diff -u carob/include/ControllerInfo.hpp:1.5
carob/include/ControllerInfo.hpp:1.6
--- carob/include/ControllerInfo.hpp:1.5 Thu Dec 21 23:23:17 2006
+++ carob/include/ControllerInfo.hpp Fri Dec 22 11:21:07 2006
@@ -88,7 +88,7 @@
ControllerInfo& operator =(const ControllerInfo& ci);
/** Less than operator used by ControllerPoolManager */
bool operator <(const ControllerInfo& ci) const;
- /** Comparison operator. Uses < operator */
+ /** Comparison operator, uses < operator */
bool operator ==(const ControllerInfo& ci) const;
/** Returns the socket address associated to this controller */
const SocketAddress& getSocketAddress() const { return socket_address; }
Index: carob/include/SocketAddress.hpp
diff -u carob/include/SocketAddress.hpp:1.3 carob/include/SocketAddress.hpp:1.4
--- carob/include/SocketAddress.hpp:1.3 Thu Dec 21 23:23:17 2006
+++ carob/include/SocketAddress.hpp Fri Dec 22 11:21:07 2006
@@ -54,7 +54,7 @@
~SocketAddress();
/**
* Creates a <code>SocketAddress</code> with the given address and length.
- * Calls #setAddress(sockaddr* sa, socklen_t l)
+ * Calls #setAddress(const sockaddr* sa, socklen_t l)
* @param sa the socket address
* @param l length of sa
*/
@@ -65,7 +65,7 @@
* @param l length of sa
*/
void setAddress(const sockaddr* sa, socklen_t l);
- /** Assignement operator, calls #setAddress(sockaddr* sa, socklen_t l) */
+ /** Assignement operator, calls #setAddress(const sockaddr* sa, socklen_t l)
*/
SocketAddress& operator = (const SocketAddress& sa);
/** Less than operator, so SocketAddress can be keys of stl maps */
bool operator < (const SocketAddress& sa) const;
Index: carob/include/StringCodecs.hpp
diff -u carob/include/StringCodecs.hpp:1.18 carob/include/StringCodecs.hpp:1.19
--- carob/include/StringCodecs.hpp:1.18 Wed Dec 20 16:29:12 2006
+++ carob/include/StringCodecs.hpp Fri Dec 22 11:21:07 2006
@@ -189,6 +189,8 @@
/**
* Converts ASCII "encoded" string to a wide string.<br>
* To be used only when the input string is definitely ASCII
+ * @param in ASCII string to convert
+ * @return converted wide string
* @see #fromString(const std::string&)
*/
static std::wstring fromASCII(const std::string& in) throw (CodecException)
@@ -202,6 +204,8 @@
/**
* Converts user's locale encoded string to a wide string<br>
* To be used for conversions of locale dependent strings, eg. system
messages
+ * @param in string to convert
+ * @return converted wide string
*/
static std::wstring fromString(const std::string& in) throw (CodecException)
{ return user_codec.decode(in); }
Index: carob/include/WatchedControllers.hpp
diff -u carob/include/WatchedControllers.hpp:1.4
carob/include/WatchedControllers.hpp:1.5
--- carob/include/WatchedControllers.hpp:1.4 Thu Dec 21 23:23:17 2006
+++ carob/include/WatchedControllers.hpp Fri Dec 22 11:21:07 2006
@@ -99,7 +99,7 @@
* Adds a controller to the list and associates the given lastTimeSeenValue
to
* it. Note that this operation is thread-safe, thus can slow-down other
* concurrent operations like [EMAIL PROTECTED] #removeController(const
ControllerInfo&)},
- * [EMAIL PROTECTED] #setControllerResponsed(const ControllerInfo&, long)}
+ * [EMAIL PROTECTED] #setControllerResponsed(const SocketAddress&, long)}
* @param ctrl controller to be added
* @param lastTimeSeen initial time to associate to this controller.
Typically
* the result of gettimeofday()
_______________________________________________
Carob-commits mailing list
[email protected]
https://forge.continuent.org/mailman/listinfo/carob-commits
