ChangeLogTag:Tue Jul 11 08:24:33 2000 Douglas C. Schmidt <schmidt@ace.cs.wustl.edu>

6 files changed, 65 insertions, 108 deletions

diff --git a/ChangeLog b/ChangeLog
index 1fc79d09f6d..807a8fcb76e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+Tue Jul 11 08:24:33 2000  Douglas C. Schmidt  <schmidt@ace.cs.wustl.edu>
+
+	* ace/POSIX_Asynch_IO.h,
+	* ace/SUN_Proactor.h: Fixed these files so that class2man
+	  now generates proper manual pages. [Bug 608]
+
 Tue Jul 11 08:07:23 2000  David L. Levine  <levine@cs.wustl.edu>
 
         * bin/generate_man_pages: don't try generate man pages for
diff --git a/ChangeLogs/ChangeLog-02a b/ChangeLogs/ChangeLog-02a
index 1fc79d09f6d..807a8fcb76e 100644
--- a/ChangeLogs/ChangeLog-02a
+++ b/ChangeLogs/ChangeLog-02a
@@ -1,3 +1,9 @@
+Tue Jul 11 08:24:33 2000  Douglas C. Schmidt  <schmidt@ace.cs.wustl.edu>
+
+	* ace/POSIX_Asynch_IO.h,
+	* ace/SUN_Proactor.h: Fixed these files so that class2man
+	  now generates proper manual pages. [Bug 608]
+
 Tue Jul 11 08:07:23 2000  David L. Levine  <levine@cs.wustl.edu>
 
         * bin/generate_man_pages: don't try generate man pages for
diff --git a/ChangeLogs/ChangeLog-03a b/ChangeLogs/ChangeLog-03a
index 1fc79d09f6d..807a8fcb76e 100644
--- a/ChangeLogs/ChangeLog-03a
+++ b/ChangeLogs/ChangeLog-03a
@@ -1,3 +1,9 @@
+Tue Jul 11 08:24:33 2000  Douglas C. Schmidt  <schmidt@ace.cs.wustl.edu>
+
+	* ace/POSIX_Asynch_IO.h,
+	* ace/SUN_Proactor.h: Fixed these files so that class2man
+	  now generates proper manual pages. [Bug 608]
+
 Tue Jul 11 08:07:23 2000  David L. Levine  <levine@cs.wustl.edu>
 
         * bin/generate_man_pages: don't try generate man pages for
diff --git a/ace/POSIX_Asynch_IO.h b/ace/POSIX_Asynch_IO.h
index 88e5303873e..ef5c48f0a76 100644
--- a/ace/POSIX_Asynch_IO.h
+++ b/ace/POSIX_Asynch_IO.h
@@ -47,13 +47,9 @@ class ACE_Export ACE_POSIX_Asynch_Result : public virtual ACE_Asynch_Result_Impl
                                            public aiocb
 {
   // = TITLE
-  //
   //     This class provides concrete implementation for
-  //     ACE_Asynch_Result for POSIX4 platforms. This class extends
+  //     <ACE_Asynch_Result> for POSIX4 platforms. This class extends
   //     <aiocb> and makes it more useful.
-  //
-  // = DESCRIPTION
-  //
 public:
   u_long bytes_transferred (void) const;
   // Number of bytes transferred by the operation.
@@ -89,7 +85,7 @@ public:
   // Priority of the operation.
 
   int signal_number (void) const;
-  // POSIX4 real-time signal number to be used for the
+  // POSIX4 realtime signal number to be used for the
   // operation. <signal_number> ranges from SIGRTMIN to SIGRTMAX. By 
   // default, SIGRTMIN is used to issue <aio_> calls.
   
@@ -134,14 +130,10 @@ protected:
 class ACE_Export ACE_POSIX_Asynch_Operation : public virtual ACE_Asynch_Operation_Impl
 {
   // = TITLE
-  //
   //     This class abstracts out the common things needed for
-  //     implementing Asynch_Operation for POSIX platforms. Specific
-  //     implementations such as POSIX_AIOCB_Asynch_Operation and
-  //     POSIX_SIG_Asynch_Operation etc., can derive from this class.
-  //
-  //  = DESCRIPTION
-  //
+  //     implementing <Asynch_Operation> for POSIX platforms. Specific
+  //     implementations such as <POSIX_AIOCB_Asynch_Operation> and
+  //     <POSIX_SIG_Asynch_Operation>, can derive from this class.
 public:
   int open (ACE_Handler &handler,
             ACE_HANDLE handle,
@@ -183,13 +175,9 @@ protected:
 class ACE_Export ACE_POSIX_AIOCB_Asynch_Operation : public virtual ACE_POSIX_Asynch_Operation
 {
   // = TITLE
-  //
-  //     This class implements ACE_Asynch_Operation for AIOCB
+  //     This class implements <ACE_Asynch_Operation> for <AIOCB>
   //     (Asynchronous I/O Control Blocks) based implementation of
   //     Proactor.
-  //
-  // = DESCRIPTION
-  //
 public:
   ACE_POSIX_AIOCB_Proactor *posix_proactor (void) const;
   // Return the underlying Proactor implementation.
@@ -223,12 +211,8 @@ protected:
 class ACE_Export ACE_POSIX_SIG_Asynch_Operation : public virtual ACE_POSIX_Asynch_Operation
 {
   // = TITLE
-  //
-  //     This class implements ACE_Asynch_Operation for Real-Time
+  //     This class implements <ACE_Asynch_Operation> for Realtime
   //     Signal (<sigtimedwait>) based implementation of Proactor.
-  //
-  // = DESCRIPTION
-  //
 public:
   ACE_POSIX_SIG_Proactor *posix_proactor (void) const;
   // Return the  underlying Proactor implemetation.
@@ -251,12 +235,8 @@ class ACE_Export ACE_POSIX_Asynch_Read_Stream_Result : public virtual ACE_Asynch
                                                        public ACE_POSIX_Asynch_Result
 {
   // = TITLE
-  //
   //     This class provides concrete implementation for
-  //     ACE_Asynch_Read_Stream::Result class for POSIX platforms.
-  //
-  // = DESCRIPTION
-  //
+  //     <ACE_Asynch_Read_Stream::Result> class for POSIX platforms.
 
   friend class ACE_POSIX_AIOCB_Asynch_Read_Stream;
   friend class ACE_POSIX_SIG_Asynch_Read_Stream;
@@ -313,7 +293,7 @@ public:
   // The priority of the asynchronous operation.
 
   int signal_number (void) const;
-  // POSIX4 real-time signal number to be used for the
+  // POSIX4 realtime signal number to be used for the
   // operation. <signal_number> ranges from SIGRTMIN to SIGRTMAX. By 
   // default, SIGRTMIN is used to issue <aio_> calls. This is a no-op
   // on non-POSIX4 systems and returns 0.
@@ -357,13 +337,9 @@ class ACE_Export ACE_POSIX_AIOCB_Asynch_Read_Stream : public virtual ACE_Asynch_
                                                       public ACE_POSIX_AIOCB_Asynch_Operation
 {
   // = TITLE
-  //
-  //     This class implements ACE_Asynch_Read_Stream for AIOCB
+  //     This class implements <ACE_Asynch_Read_Stream> for <AIOCB>
   //     (Asynchronous I/O Control Blocks) based implementation of
   //      Proactor.
-  //
-  // = DESCRIPTION
-  //
 public:
   ACE_POSIX_AIOCB_Asynch_Read_Stream (ACE_POSIX_AIOCB_Proactor *posix_aiocb_proactor);
   // Constructor.
@@ -410,12 +386,8 @@ class ACE_Export ACE_POSIX_SIG_Asynch_Read_Stream : public virtual ACE_Asynch_Re
                                                     public ACE_POSIX_SIG_Asynch_Operation
 {
   // = TITLE
-  //
-  //     This class implements ACE_Asynch_Read_Stream for Real-Time
+  //     This class implements <ACE_Asynch_Read_Stream> for Realtime
   //     Signal (<sigtimedwait>) based implementation of Proactor.
-  //
-  // = DESCRIPTION
-  //
 public:
   ACE_POSIX_SIG_Asynch_Read_Stream (ACE_POSIX_SIG_Proactor *posix_sig_proactor);
   // Constructor.
@@ -461,12 +433,10 @@ class ACE_Export ACE_POSIX_Asynch_Write_Stream_Result : public virtual ACE_Async
                                                         public ACE_POSIX_Asynch_Result
 {
   // = TITLE
-  //
   //     This class provides concrete implementation for
-  //     ACE_Asynch_Write_Stream::Result on POSIX platforms.
+  //     <ACE_Asynch_Write_Stream::Result> on POSIX platforms.
   //
   // = DESCRIPTION
-  //
   //     This class has all the information necessary for the
   //     <handler> to uniquiely identify the completion of the
   //     asynchronous write.
@@ -526,7 +496,7 @@ public:
   // The priority of the asynchronous operation.
 
   int signal_number (void) const;
-  // POSIX4 real-time signal number to be used for the
+  // POSIX4 realtime signal number to be used for the
   // operation. <signal_number> ranges from SIGRTMIN to SIGRTMAX. By 
   // default, SIGRTMIN is used to issue <aio_> calls. This is a no-op
   // on non-POSIX4 systems and returns 0.
@@ -571,13 +541,9 @@ class ACE_Export ACE_POSIX_AIOCB_Asynch_Write_Stream : public virtual ACE_Asynch
                                                        public ACE_POSIX_AIOCB_Asynch_Operation
 {
   // = TITLE
-  //
-  //     This class implements ACE_Asynch_Write_Stream for AIOCB
+  //     This class implements <ACE_Asynch_Write_Stream> for <AIOCB>
   //     (Asynchronous I/O Control Blocks) based implementation of
   //      Proactor.
-  //
-  // = DESCRIPTION
-  //
 public:
   ACE_POSIX_AIOCB_Asynch_Write_Stream (ACE_POSIX_AIOCB_Proactor *posix_aiocb_proactor);
   // Constructor.
@@ -623,12 +589,8 @@ class ACE_Export ACE_POSIX_SIG_Asynch_Write_Stream : public virtual ACE_Asynch_W
                                                      public ACE_POSIX_SIG_Asynch_Operation
 {
   // = TITLE
-  //
-  //     This class implements ACE_Asynch_Write_Stream for Real-Time
+  //     This class implements <ACE_Asynch_Write_Stream> for Realtime
   //     Signal (<sigtimedwait>) based implementation of Proactor.
-  //
-  // = DESCRIPTION
-  //
 public:
   ACE_POSIX_SIG_Asynch_Write_Stream (ACE_POSIX_SIG_Proactor *posix_sig_proactor);
   // Constrctor.
@@ -674,12 +636,8 @@ class ACE_Export ACE_POSIX_Asynch_Read_File_Result : public virtual ACE_Asynch_R
                                                      public ACE_POSIX_Asynch_Read_Stream_Result
 {
   // = TITLE
-  //
   //     This class provides concrete implementation for
-  //     ACE_Asynch_Read_File::Result class for POSIX platforms.
-  //
-  // = DESCRIPTION
-  //
+  //     <ACE_Asynch_Read_File::Result> class for POSIX platforms.
 
   friend class ACE_POSIX_AIOCB_Asynch_Read_File;
   friend class ACE_POSIX_SIG_Asynch_Read_File;
@@ -727,7 +685,7 @@ public:
   // The priority of the asynchronous operation.
 
   int signal_number (void) const;
-  // POSIX4 real-time signal number to be used for the
+  // POSIX4 realtime signal number to be used for the
   // operation. <signal_number> ranges from SIGRTMIN to SIGRTMAX. By 
   // default, SIGRTMIN is used to issue <aio_> calls. This is a no-op
   // on non-POSIX4 systems and returns 0.
@@ -778,21 +736,20 @@ class ACE_Export ACE_POSIX_AIOCB_Asynch_Read_File : public virtual ACE_Asynch_Re
                                                     public ACE_POSIX_AIOCB_Asynch_Read_Stream
 {
   // = TITLE
-  //
   //     This class is a factory for starting off asynchronous reads
-  //     on a file. This class implements ACE_Asynch_Read_File for
-  //     AIOCB (Asynchronous I/O Control Blocks) based implementation
+  //     on a file. This class implements <ACE_Asynch_Read_File> for
+  //     <AIOCB> (Asynchronous I/O Control Blocks) based implementation
   //     of Proactor.
   //
   // = DESCRIPTION
   //
   //     Once <open> is called, multiple asynchronous <read>s can
-  //     started using this class.  A ACE_Asynch_Read_File::Result
+  //     started using this class.  A <ACE_Asynch_Read_File::Result>
   //     will be passed back to the <handler> when the asynchronous
   //     reads completes through the <ACE_Handler::handle_read_file>
   //     callback.
   //
-  //     This class differs slightly from ACE_Asynch_Read_Stream as it
+  //     This class differs slightly from <ACE_Asynch_Read_Stream> as it
   //     allows the user to specify an offset for the read.
 
 public:
@@ -849,16 +806,14 @@ class ACE_Export ACE_POSIX_SIG_Asynch_Read_File : public virtual ACE_Asynch_Read
                                                   public ACE_POSIX_SIG_Asynch_Read_Stream
 {
   // = TITLE
-  //
   //     This class is a factory for starting off asynchronous reads
-  //     on a file. This class implements ACE_Asynch_Operation for
-  //     Real-Time Signal (<sigtimedwait>) based implementation of
+  //     on a file. This class implements <ACE_Asynch_Operation> for
+  //     Realtime Signal (<sigtimedwait>) based implementation of
   //     Proactor.
   //
   // = DESCRIPTION
-  //
   //     Once <open> is called, multiple asynchronous <read>s can
-  //     started using this class.  A ACE_Asynch_Read_File::Result
+  //     started using this class.  A <ACE_Asynch_Read_File::Result>
   //     will be passed back to the <handler> when the asynchronous
   //     reads completes through the <ACE_Handler::handle_read_file>
   //     callback.
@@ -916,9 +871,8 @@ class ACE_Export ACE_POSIX_Asynch_Write_File_Result : public virtual ACE_Asynch_
                                                       public ACE_POSIX_Asynch_Write_Stream_Result
 {
   // = TITLE
-  //
   //     This class provides implementation for
-  //      ACE_Asynch_Write_File_Result for POSIX platforms.
+  //     <ACE_Asynch_Write_File_Result> for POSIX platforms.
   //
   // = DESCRIPTION
   //
@@ -927,11 +881,11 @@ class ACE_Export ACE_POSIX_Asynch_Write_File_Result : public virtual ACE_Asynch_
   //     asynchronous write.
   //
   //     This class differs slightly from
-  //     ACE_Asynch_Write_Stream::Result as it calls back
-  //     <ACE_Handler::handle_write_file> on the <handler> instead
-  //     of <ACE_Handler::handle_write_stream>.  No additional state
-  //     is required by this class as ACE_Asynch_Result can store
-  //     the <offset>.
+  //     <ACE_Asynch_Write_Stream::Result> as it calls back
+  //     <ACE_Handler::handle_write_file> on the <handler> instead of
+  //     <ACE_Handler::handle_write_stream>.  No additional state is
+  //     required by this class as <ACE_Asynch_Result> can store the
+  //     <offset>.
 
   friend class ACE_POSIX_AIOCB_Asynch_Write_File;
   friend class ACE_POSIX_SIG_Asynch_Write_File;
@@ -978,7 +932,7 @@ public:
   // The priority of the asynchronous operation.
 
   int signal_number (void) const;
-  // POSIX4 real-time signal number to be used for the
+  // POSIX4 realtime signal number to be used for the
   // operation. <signal_number> ranges from SIGRTMIN to SIGRTMAX. By 
   // default, SIGRTMIN is used to issue <aio_> calls. This is a no-op
   // on non-POSIX4 systems and returns 0.
@@ -1029,9 +983,8 @@ class ACE_Export ACE_POSIX_AIOCB_Asynch_Write_File : public virtual ACE_Asynch_W
                                                      public ACE_POSIX_AIOCB_Asynch_Write_Stream
 {
   // = TITLE
-  //
   //     This class provides concrete implementation for
-  //     ACE_Asynch_Write_File for POSIX platforms where the
+  //     <ACE_Asynch_Write_File> for POSIX platforms where the
   //     completion strategy for Proactor is based on AIOCB (AIO
   //     Control Blocks).
   //
@@ -1091,16 +1044,14 @@ class ACE_Export ACE_POSIX_SIG_Asynch_Write_File : public virtual ACE_Asynch_Wri
                                                    public ACE_POSIX_SIG_Asynch_Write_Stream
 {
   // = TITLE
-  //
   //     This class is a factory for starting off asynchronous reads
-  //     on a file. This class implements ACE_Asynch_Operation for
-  //     Real-Time Signal (<sigtimedwait>) based implementation of
+  //     on a file. This class implements <ACE_Asynch_Operation> for
+  //     Realtime Signal (<sigtimedwait>) based implementation of
   //     Proactor.
   //
   // = DESCRIPTION
-  //
   //     Once <open> is called, multiple asynchronous <read>s can
-  //     started using this class.  A ACE_Asynch_Read_File::Result
+  //     started using this class.  A <ACE_Asynch_Read_File::Result>
   //     will be passed back to the <handler> when the asynchronous
   //     reads completes through the <ACE_Handler::handle_read_file>
   //     callback.
@@ -1159,7 +1110,6 @@ class ACE_Export ACE_POSIX_Asynch_Accept_Result : public virtual ACE_Asynch_Acce
                                                   public ACE_POSIX_Asynch_Result
 {
   // = TITLE
-  //
   //     This is that class which will be passed back to the
   //     <handler> when the asynchronous accept completes.
   //
@@ -1227,7 +1177,7 @@ public:
   // The priority of the asynchronous operation. 
 
   int signal_number (void) const;
-  // POSIX4 real-time signal number to be used for the
+  // POSIX4 realtime signal number to be used for the
   // operation. <signal_number> ranges from SIGRTMIN to SIGRTMAX. By 
   // default, SIGRTMIN is used to issue <aio_> calls. This is a no-op
   // on non-POSIX4 systems and returns 0.
@@ -1339,12 +1289,8 @@ class ACE_Export ACE_POSIX_SIG_Asynch_Accept : public virtual ACE_Asynch_Accept_
                                                public ACE_POSIX_SIG_Asynch_Operation
 {
   // = TITLE
-  //
-  //     This class implements ACE_Asynch_Accept for Real-Time
+  //     This class implements <ACE_Asynch_Accept> for Realtime
   //     Signal (<sigtimedwait>) based implementation of Proactor.
-  //
-  // = DESCRIPTION
-  //
 public:
   ACE_POSIX_SIG_Asynch_Accept (ACE_POSIX_SIG_Proactor *posix_sig_proactor);
   // Constructor.
@@ -1402,12 +1348,10 @@ class ACE_Export ACE_POSIX_Asynch_Transmit_File_Result : public virtual ACE_Asyn
                                                          public ACE_POSIX_Asynch_Result
 {
   // = TITLE
-  //
   //     This is that class which will be passed back to the
   //     <handler> when the asynchronous transmit file completes.
   //
   // = DESCRIPTION
-  //
   //     This class has all the information necessary for the
   //     <handler> to uniquiely identify the completion of the
   //     asynchronous transmit file.
@@ -1482,7 +1426,7 @@ public:
   // The priority of the asynchronous operation.
 
   int signal_number (void) const;
-  // POSIX4 real-time signal number to be used for the
+  // POSIX4 realtime signal number to be used for the
   // operation. <signal_number> ranges from SIGRTMIN to SIGRTMAX. By 
   // default, SIGRTMIN is used to issue <aio_> calls. This is a no-op
   // on non-POSIX4 systems and returns 0.
@@ -1595,12 +1539,8 @@ class ACE_Export ACE_POSIX_SIG_Asynch_Transmit_File : public virtual ACE_Asynch_
                                                       public ACE_POSIX_SIG_Asynch_Operation
 {
   // = TITLE
-  //
-  //     This class implements ACE_Asynch_Transmit_File for Real-Time
+  //     This class implements <ACE_Asynch_Transmit_File> for Realtime
   //     Signal (<sigtimedwait>) based implementation of Proactor.
-  //
-  // = DESCRIPTION
-  //
 public:
   ACE_POSIX_SIG_Asynch_Transmit_File (ACE_POSIX_SIG_Proactor *posix_sig_proactor);
   // Constructor.
@@ -1654,4 +1594,3 @@ public:
 
 #endif /* ACE_HAS_AIO_CALLS */
 #endif /* ACE_POSIX_ASYNCH_IO_H */
-//==================================================
diff --git a/ace/POSIX_Proactor.h b/ace/POSIX_Proactor.h
index 6796011cc8d..993be88a96f 100644
--- a/ace/POSIX_Proactor.h
+++ b/ace/POSIX_Proactor.h
@@ -41,8 +41,8 @@ class ACE_Export ACE_POSIX_Proactor : public ACE_Proactor_Impl
   //     AIOCBs are stored and completion status of the corresponding
   //     operations are queried on them. The other one is based on
   //     POSIX Real Time signals. This class abstracts out the common
-  //     code needed for both the strategies. ACE_AIOCB_Proactor and
-  //     ACE_SIG_Proactor specialize this class for each strategy.
+  //     code needed for both the strategies. <ACE_AIOCB_Proactor> and
+  //     <ACE_SIG_Proactor> specialize this class for each strategy.
 
   friend class ACE_POSIX_SIG_Asynch_Accept_Handler;
   // For <POSIX_SIG_Asynch_Accept> operation, this handler class does
diff --git a/ace/SUN_Proactor.h b/ace/SUN_Proactor.h
index 148b27e23ae..4f075cb0e47 100644
--- a/ace/SUN_Proactor.h
+++ b/ace/SUN_Proactor.h
@@ -30,7 +30,7 @@ class ACE_Export ACE_SUN_Proactor : public ACE_POSIX_AIOCB_Proactor
   //     for SunOS 5.6, 5.7, etc.
   //
   // = DESCRIPTION
-  //     This proactor, based on ACE_POSIX_AIOCB_Proactor,
+  //     This proactor, based on <ACE_POSIX_AIOCB_Proactor>,
   //     works with Sun native interface for aio calls.
   //     POSIX_API          Native SUN_API
   //     aio_read           aioread
@@ -39,14 +39,14 @@ class ACE_Export ACE_SUN_Proactor : public ACE_POSIX_AIOCB_Proactor
   //     aio_error          aio_result_t.errno
   //     aio_return         aio_result_t.return
   //   
-  //     On Solaris, the Sun aio*() native implementation is more
-  //     reliable and efficient than POSIX aio_*() implementation.
+  //     On Solaris, the Sun <aio*()> native implementation is more
+  //     reliable and efficient than POSIX <aio_*()> implementation.
   //     There is a problem of lost RT signals with POSIX, if we start
   //     more than SIGQUEUEMAX asynchronous operations at the same
   //     time.
   //
-  //     The Sun aiocb it is not standard aiocb, instead, it has the
-  //     following structure:
+  //     The Sun <aiocb> it is not the standard POSX <aiocb>, instead,
+  //     it has the following structure:
   // 
   //     typedef struct aiocb
   //     {
@@ -108,4 +108,4 @@ protected:
 
 #endif /* ACE_HAS_AIO_CALLS && sun */
 #endif /* ACE_SUN_PROACTOR_H*/
-//======================================================================
+