CVS update of carob/include (4 files)

    Date: Monday, December 18, 2006 @ 17:42:55
  Author: gilles
    Path: /cvsroot/carob/carob/include

Modified: CarobException.hpp (1.53 -> 1.54) Connection.hpp (1.76 -> 1.77)
          ControllerPool.hpp (1.10 -> 1.11)
          ControllerStateChangedCallback.hpp (1.4 -> 1.5)

Javadoc fixes


------------------------------------+
 CarobException.hpp                 |   16 +++++++++++++---
 Connection.hpp                     |    3 ++-
 ControllerPool.hpp                 |    4 ++--
 ControllerStateChangedCallback.hpp |    4 +++-
 4 files changed, 20 insertions(+), 7 deletions(-)


Index: carob/include/CarobException.hpp
diff -u carob/include/CarobException.hpp:1.53 
carob/include/CarobException.hpp:1.54
--- carob/include/CarobException.hpp:1.53       Tue Dec  5 02:19:42 2006
+++ carob/include/CarobException.hpp    Mon Dec 18 17:42:55 2006
@@ -67,6 +67,7 @@
 public:
   /**
    * Copy constructor. Copying, NOT chaining!
+   * @param ce source exception to copy from
    */
   CarobException(const CarobException& ce);
   /**
@@ -168,6 +169,10 @@
   /**
    * Constructs an UnexpectedException with the given message
    *
+   * @param  messagePrm the detailed user-friendly message
+   * @param  SQLStatePrm the SQL2 standard error code.
+   * @param  causePrm the exception that generated this one, if any.
+   * @param  vendorPrm the (deprecated) SQL1 error code
    * @see CarobException
    */
   UnexpectedException(const std::wstring& messagePrm,
@@ -227,6 +232,10 @@
   /**
    * Constructs a ConnectionException
    *
+   * @param  messagePrm the detailed user-friendly message
+   * @param  SQLStatePrm the SQL2 standard error code.
+   * @param  causePrm the exception that generated this one, if any.
+   * @param  vendorPrm the (deprecated) SQL1 error code
    * @see DriverException
    */
   ConnectionException(const std::wstring& messagePrm,
@@ -381,10 +390,11 @@
       UnexpectedException);
   /**
    * Provides a string representation of the element.
-   * @return all members formated in a single string
+   * @param oss stream to write to
+   * @param ste stack trace element to be printed
+   * @return given stream printed with all members formated in a single string
    */
-  friend std::wostream&
-  operator<< (std::wostream& oss, const StackTraceElement& ste);
+  friend std::wostream& operator<< (std::wostream& oss, const 
StackTraceElement& ste);
 
 private:
   // we would like to have const members (and initializer lists)
Index: carob/include/Connection.hpp
diff -u carob/include/Connection.hpp:1.76 carob/include/Connection.hpp:1.77
--- carob/include/Connection.hpp:1.76   Mon Dec 11 19:14:45 2006
+++ carob/include/Connection.hpp        Mon Dec 18 17:42:55 2006
@@ -392,7 +392,8 @@
                           AuthenticationException, UnexpectedException);
   /**
    * Reads the controller acknowledgements and misc parameters that finish 
-   * connection. {@link #initConnection()} must be called before this
+   * connection. {@link #initConnectionToNextController()} must be called 
before
+   * this.
    * @throw ConnectionException if the virtual database is not available on the
    *        controller
    * @throw AuthenticationException if the controller did not acknowledge or in
Index: carob/include/ControllerPool.hpp
diff -u carob/include/ControllerPool.hpp:1.10 
carob/include/ControllerPool.hpp:1.11
--- carob/include/ControllerPool.hpp:1.10       Mon Dec 11 19:14:45 2006
+++ carob/include/ControllerPool.hpp    Mon Dec 18 17:42:55 2006
@@ -91,7 +91,7 @@
    * the controller is detected as failed
    * 
    * @param controller the controller to which the socket is connected
-   * @param socketFd the socket file descriptor to register
+   * @param socket the socket to register
    */
   void                        registerSocket(const ControllerInfo& controller,
                                   JavaSocket* socket);
@@ -101,7 +101,7 @@
    * or deleted. To be used when socket creation or connection failed
    * 
    * @param controller the controller to which the socket is connected
-   * @param socketFd the socket file descriptor to unregister
+   * @param socket the socket to unregister
    */
   void                        unRegisterSocket(const ControllerInfo& 
controller,
                                   JavaSocket* socket);
Index: carob/include/ControllerStateChangedCallback.hpp
diff -u carob/include/ControllerStateChangedCallback.hpp:1.4 
carob/include/ControllerStateChangedCallback.hpp:1.5
--- carob/include/ControllerStateChangedCallback.hpp:1.4        Mon Dec 11 
19:14:45 2006
+++ carob/include/ControllerStateChangedCallback.hpp    Mon Dec 18 17:42:55 2006
@@ -87,8 +87,10 @@
    * Removes the given socket from the list of monitored sockets for a given
    * controller. This function should be called when socket creation or
    * connection failed
+   * @param ctrl controller to which given socket was connected 
+   * @param socket the socket to un register
    */
-  void unRegisterSocket(const ControllerInfo& ctrl, JavaSocket* socketFd);
+  void unRegisterSocket(const ControllerInfo& ctrl, JavaSocket* socket);
 private:
   /** The list of controllers with their set of sockets */
   std::map<ControllerInfo, std::vector<JavaSocket*> >  controllers_and_sockets;