1 files changed, 65 insertions, 51 deletions

diff --git a/ACE/examples/Web_Crawler/Iterators.h b/ACE/examples/Web_Crawler/Iterators.h
index b5d267f7afb..27b7ae46052 100644
--- a/ACE/examples/Web_Crawler/Iterators.h
+++ b/ACE/examples/Web_Crawler/Iterators.h
@@ -1,18 +1,15 @@
 /* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-//    examples/Web_Crawler
-//
-// = FILENAME
-//    Iterators.h
-//
-// = AUTHOR
-//    Douglas C. Schmidt <schmidt@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ *  @file    Iterators.h
+ *
+ *  $Id$
+ *
+ *  @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
+ */
+//=============================================================================
+
 
 #ifndef _ITERATORS_H
 #define _ITERATORS_H
@@ -23,95 +20,112 @@
 #pragma once
 #endif /* ACE_LACKS_PRAGMA_ONCE */
 
+/**
+ * @class URL_Iterator
+ *
+ * @brief An abstract base class that defines an iterator.
+ *
+ * Subclasses of this base class can define what strings
+ * to return from <next>.  This class decouples higher-level
+ * software from the details of whatever type of URL header or
+ * body we're iterating over.
+ */
 class URL_Iterator
 {
-  // = TITLE
-  //    An abstract base class that defines an iterator.
-  // 
-  // = DESCRIPTION
-  //    Subclasses of this base class can define what strings
-  //    to return from <next>.  This class decouples higher-level
-  //    software from the details of whatever type of URL header or
-  //    body we're iterating over.
 public:
   // = Initialization and termination methods.
+  /// "virtual" destructor.
   virtual int destroy (void);
-  // "virtual" destructor.
 
   // = Iterator methods.
+  /// Pass back the next <string> that hasn't been seen yet.  Returns 0
+  /// when all items have been seen, else 1.
   virtual int next (ACE_CString &string) = 0;
-  // Pass back the next <string> that hasn't been seen yet.  Returns 0
-  // when all items have been seen, else 1.
 
 protected:
+  /// C++ destructor.
   virtual ~URL_Iterator (void);
-  // C++ destructor.
 };
 
+/**
+ * @class HTML_Body_Iterator
+ *
+ * @brief An iterator that returns URLs embedded in HTML files.
+ */
 class HTML_Body_Iterator : public URL_Iterator
 {
-  // = TITLE
-  //    An iterator that returns URLs embedded in HTML files.
 public:
   // = Initialization and termination methods.
+  /// Constructor.
   HTML_Body_Iterator (URL &url);
-  // Constructor.
 
   // = Iterator methods.
+  /**
+   * Pass back the next <url> that hasn't been seen in the
+   * memory-mapped file.  Returns 0 when all items have been seen,
+   * else 1.
+   */
   virtual int next (ACE_CString &url);
-  // Pass back the next <url> that hasn't been seen in the
-  // memory-mapped file.  Returns 0 when all items have been seen,
-  // else 1.
 
 private:
+  /// HTTP URL that we're iterating over.
   URL &url_;
-  // HTTP URL that we're iterating over.
 };
 
+/**
+ * @class HTTP_Header_Iterator
+ *
+ * @brief An iterator that iterates over the HTTP header.
+ */
 class HTTP_Header_Iterator : public URL_Iterator
 {
-  // = TITLE
-  //    An iterator that iterates over the HTTP header.
 public:
   // = Initialization and termination methods.
+  /// Constructor.
   HTTP_Header_Iterator (URL &url);
-  // Constructor.
 
   // = Iterator methods.
+  /**
+   * Pass back the next <line> that hasn't been seen in the
+   * memory-mapped file header.  Returns 0 when we've reached the end
+   * of the header.  seen, else 1.
+   */
   virtual int next (ACE_CString &line);
-  // Pass back the next <line> that hasn't been seen in the
-  // memory-mapped file header.  Returns 0 when we've reached the end
-  // of the header.  seen, else 1.
 
 private:
+  /// HTTP URL that we're iterating over.
   URL &url_;
-  // HTTP URL that we're iterating over.
 
+  /// We've found the end of the header, which means this iterator is
+  /// finished.
   int end_of_header_;
-  // We've found the end of the header, which means this iterator is
-  // finished.
 };
 
+/**
+ * @class URL_Download_Iterator
+ *
+ * @brief An iterator that iterates over the contents of an entire URL,
+ * i.e., both header and body, and returns it in <BUFSIZ>
+ * <buffer>s.
+ */
 class URL_Download_Iterator : public URL_Iterator
 {
-  // = TITLE
-  //    An iterator that iterates over the contents of an entire URL,
-  //    i.e., both header and body, and returns it in <BUFSIZ>
-  //    <buffer>s. 
 public:
   // = Initialization and termination methods.
+  /// Constructor.
   URL_Download_Iterator (URL &url);
-  // Constructor.
 
   // = Iterator methods.
+  /**
+   * Pass back the next <buffer> data from the stream, where
+   * <buffer.size> <= <BUFSIZ> .  Returns 0 when we've reached the end
+   * of the header, else 1.
+   */
   virtual int next (ACE_CString &buffer);
-  // Pass back the next <buffer> data from the stream, where
-  // <buffer.size> <= <BUFSIZ> .  Returns 0 when we've reached the end
-  // of the header, else 1.
 
 private:
+  /// HTTP URL that we're iterating over.
   URL &url_;
-  // HTTP URL that we're iterating over.
 };
 
 #endif /* _ITERATORS_H */