Merge pull request #1115 from jwillemsen/jwi-ssldoxygen

Layout and doxygen changes

6 files changed, 15 insertions, 36 deletions

diff --git a/ACE/ace/SSL/SSL_Asynch_Stream.h b/ACE/ace/SSL/SSL_Asynch_Stream.h
index de2a9dc169b..7a965995a76 100644
--- a/ACE/ace/SSL/SSL_Asynch_Stream.h
+++ b/ACE/ace/SSL/SSL_Asynch_Stream.h
@@ -373,7 +373,6 @@ private:
   ACE_SSL_Asynch_Stream & operator= (ACE_SSL_Asynch_Stream const &);
 
 protected:
-
   /// Stream Type ST_CLIENT/ST_SERVER
   Stream_Type type_;
 
@@ -447,7 +446,6 @@ protected:
 
   /// Mutex to protect work
   ACE_SYNCH_MUTEX mutex_;
-
 };
 
 ACE_END_VERSIONED_NAMESPACE_DECL
diff --git a/ACE/ace/SSL/SSL_SOCK.h b/ACE/ace/SSL/SSL_SOCK.h
index 16e84af890f..29df1c85ce2 100644
--- a/ACE/ace/SSL/SSL_SOCK.h
+++ b/ACE/ace/SSL/SSL_SOCK.h
@@ -39,7 +39,6 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
 class ACE_SSL_Export ACE_SSL_SOCK : public ACE_SOCK
 {
 public:
-
   /**
    * Override ACE_SOCK base class implementations with these SSL
    * specific ones.
@@ -61,7 +60,6 @@ public:
   //@}
 
 protected:
-
   /// Default constructor is private to prevent instances of this class
   /// from being defined.
   ACE_SSL_SOCK (void);
@@ -73,7 +71,6 @@ protected:
    * ACE_SSL_SOCK pointer/reference.
    */
   ~ACE_SSL_SOCK (void);
-
 };
 
 ACE_END_VERSIONED_NAMESPACE_DECL
diff --git a/ACE/ace/SSL/SSL_SOCK_Acceptor.cpp b/ACE/ace/SSL/SSL_SOCK_Acceptor.cpp
index d790662af29..9ec3d58e9a2 100644
--- a/ACE/ace/SSL/SSL_SOCK_Acceptor.cpp
+++ b/ACE/ace/SSL/SSL_SOCK_Acceptor.cpp
@@ -23,7 +23,6 @@ ACE_SSL_SOCK_Acceptor::~ACE_SSL_SOCK_Acceptor (void)
   ACE_TRACE ("ACE_SSL_SOCK_Acceptor::~ACE_SSL_SOCK_Acceptor");
 }
 
-
 int
 ACE_SSL_SOCK_Acceptor::ssl_accept (ACE_SSL_SOCK_Stream &new_stream,
                                    ACE_Time_Value *timeout) const
diff --git a/ACE/ace/SSL/SSL_SOCK_Acceptor.h b/ACE/ace/SSL/SSL_SOCK_Acceptor.h
index 83f56510005..e71226be9fe 100644
--- a/ACE/ace/SSL/SSL_SOCK_Acceptor.h
+++ b/ACE/ace/SSL/SSL_SOCK_Acceptor.h
@@ -49,7 +49,6 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
 class ACE_SSL_Export ACE_SSL_SOCK_Acceptor : public ACE_SSL_SOCK
 {
 public:
-
   /// Default constructor.
   ACE_SSL_SOCK_Acceptor (void);
 
@@ -175,16 +174,13 @@ public:
   ACE_ALLOC_HOOK_DECLARE;
 
 protected:
-
   /// Complete SSL passive connection establishment.
   int ssl_accept (ACE_SSL_SOCK_Stream &new_stream,
                   ACE_Time_Value *timeout) const;
 
 private:
-
   /// The BSD-socket workhorse
   ACE_SOCK_Acceptor acceptor_;
-
 };
 
 ACE_END_VERSIONED_NAMESPACE_DECL
diff --git a/ACE/ace/SSL/SSL_SOCK_Connector.h b/ACE/ace/SSL/SSL_SOCK_Connector.h
index 4c862c9fbac..72917a0abb0 100644
--- a/ACE/ace/SSL/SSL_SOCK_Connector.h
+++ b/ACE/ace/SSL/SSL_SOCK_Connector.h
@@ -53,9 +53,7 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  */
 class ACE_SSL_Export ACE_SSL_SOCK_Connector
 {
-
 public:
-
   /// Default constructor.
   ACE_SSL_SOCK_Connector (void);
 
@@ -292,17 +290,14 @@ public:
   ACE_ALLOC_HOOK_DECLARE;
 
 protected:
-
   /// Complete non-blocking SSL active connection.
   int ssl_connect (ACE_SSL_SOCK_Stream &new_stream,
                    const ACE_Time_Value *timeout);
 
 private:
-
   /// The class that does all of the non-secure socket connection.
-  /// It is default contructed, and subsequently used by connect().
+  /// It is default constructed, and subsequently used by connect().
   ACE_SOCK_Connector connector_;
-
 };
 
 ACE_END_VERSIONED_NAMESPACE_DECL
diff --git a/ACE/ace/SSL/SSL_SOCK_Stream.h b/ACE/ace/SSL/SSL_SOCK_Stream.h
index bce3cd9ec6f..ed75a132747 100644
--- a/ACE/ace/SSL/SSL_SOCK_Stream.h
+++ b/ACE/ace/SSL/SSL_SOCK_Stream.h
@@ -60,7 +60,6 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
 class ACE_SSL_Export ACE_SSL_SOCK_Stream : public ACE_SSL_SOCK
 {
 public:
-
   /// Constructor
   /**
    * @param context Pointer to @c ACE_SSL_Context instance containing
@@ -147,8 +146,8 @@ public:
                 const ACE_Time_Value *timeout) const;
 
   /**
-   * Wait to to timeout amount of time to send up to n bytes into
-   * buf (uses the send() call).  If send() times out
+   * Wait to to timeout amount of time to send up to @a n bytes into
+   * @a buf (uses the send() call).  If send() times out
    * a -1 is returned with errno == ETIME.  If it succeeds the
    * number of bytes sent is returned.
    */
@@ -157,8 +156,8 @@ public:
                 const ACE_Time_Value *timeout) const;
 
   /**
-   * Wait up to timeout amount of time to receive up to n bytes
-   * into buf (uses the recv() call).  If recv() times
+   * Wait up to timeout amount of time to receive up to @a n bytes
+   * into @a buf (uses the recv() call).  If recv() times
    * out a -1 is returned with @c errno == ETIME.  If it succeeds the
    * number of bytes received is returned.
    */
@@ -166,18 +165,18 @@ public:
                 size_t n,
                 const ACE_Time_Value *timeout) const;
 
-  /// Send n varargs messages to the connected ssl socket.
+  /// Send @a n varargs messages to the connected ssl socket.
   ssize_t send (size_t n,
                 ...) const;
 
-  /// Recv n varargs messages to the connected ssl socket.
+  /// Recv @a n varargs messages to the connected ssl socket.
   ssize_t recv (size_t n,
                 ...) const;
 
-  /// Send n bytes, keep trying until n are sent.
+  /// Send @a n bytes, keep trying until n are sent.
   ssize_t send_n (const void *buf, int n) const;
 
-  /// Recv n bytes, keep trying until n are received.
+  /// Recv @a n bytes, keep trying until @a n are received.
   ssize_t recv_n (void *buf, int n) const;
 
   /**
@@ -185,14 +184,14 @@ public:
    * for recv_n(), and no flags are supported for send_n().
    */
   //@{
-  /// Send n bytes, keep trying until n are sent.
+  /// Send @a n bytes, keep trying until @a n are sent.
   ssize_t send_n (const void *buf, int n, int flags) const;
 
-  /// Recv n bytes, keep trying until n are sent.
+  /// Recv @a n bytes, keep trying until @a n are sent.
   ssize_t recv_n (void *buf, int n, int flags) const;
 
   /**
-   * Try to send exactly len bytes into buf (uses the send() call).
+   * Try to send exactly @a len bytes into @a buf (uses the send() call).
    * If send() blocks for longer than timeout the number of bytes
    * actually sent is returned with errno == ETIME.  If a timeout does
    * not occur, send_n() return len (i.e., the number of bytes
@@ -205,7 +204,7 @@ public:
                   size_t *bytes_transferred = 0) const;
 
   /**
-   * Try to send exactly len bytes into buf (uses the send() call).
+   * Try to send exactly @a len bytes into @a buf (uses the send() call).
    * If send() blocks for longer than timeout the number of bytes
    * actually sent is returned with errno == ETIME.  If a timeout does
    * not occur, send_n() return len (i.e., the number of bytes
@@ -217,7 +216,7 @@ public:
                   size_t *bytes_transferred = 0) const;
 
   /**
-   * Try to receive exactly len bytes into buf (uses the recv() call).
+   * Try to receive exactly @a len bytes into @a buf (uses the recv() call).
    * The ACE_Time_Value indicates how long to blocking trying to
    * receive.  If timeout == 0, the caller will block until action is
    * possible, else will wait until the relative time specified in
@@ -259,7 +258,6 @@ public:
   ssize_t recvv_n (iovec iov[],
                    size_t n) const;
 
-
   /**
    * Selectively close endpoints.
    */
@@ -293,7 +291,7 @@ public:
 
   /**
    * Return the address of the remotely connected peer (if there is
-   * one), in the referenced <ACE_Addr>. Returns 0 if successful, else
+   * one), in the referenced ACE_Addr. Returns 0 if successful, else
    * -1.
    *
    * @note If the TCP connection has been completed but the SSL
@@ -306,7 +304,6 @@ public:
   ACE_SOCK_Stream & peer (void);
 
 protected:
-
   /// Underlying send() helper method common to all public send()
   /// methods.
   ssize_t send_i (const void *buf,
@@ -321,18 +318,15 @@ protected:
                   const ACE_Time_Value *timeout) const;
 
 private:
-
   ACE_UNIMPLEMENTED_FUNC (void operator= (const ACE_SSL_SOCK_Stream &))
   ACE_UNIMPLEMENTED_FUNC (ACE_SSL_SOCK_Stream (const ACE_SSL_SOCK_Stream &))
 
 protected:
-
   /// The SSL session.
   SSL *ssl_;
 
   /// The stream which works under the ssl connection.
   ACE_SOCK_Stream stream_;
-
 };
 
 ACE_END_VERSIONED_NAMESPACE_DECL