From: Amos Jeffries <squid3@treenet.co.nz>
Date: Wed, 14 Jul 2010 13:40:40 +0000 (+1200)
Subject: Document BodyPipe.h
X-Git-Tag: SQUID_3_2_0_1~60
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d1c37eab558f6daa7e28cbf02e634fee76957612;p=thirdparty%2Fsquid.git

Document BodyPipe.h
---

diff --git a/src/BodyPipe.h b/src/BodyPipe.h
index e8ccb52611..e3793ee412 100644
--- a/src/BodyPipe.h
+++ b/src/BodyPipe.h
@@ -1,4 +1,3 @@
-
 #ifndef SQUID_BODY_PIPE_H
 #define SQUID_BODY_PIPE_H
 
@@ -8,9 +7,10 @@
 
 class BodyPipe;
 
-// Interface for those who want to produce body content for others.
-// BodyProducer is expected to create the BodyPipe.
-// One pipe cannot have more than one producer.
+/** Interface for those who want to produce body content for others.
+ * BodyProducer is expected to create the BodyPipe.
+ * One pipe cannot have more than one producer.
+ */
 class BodyProducer: virtual public AsyncJob
 {
 public:
@@ -24,10 +24,11 @@ protected:
     void stopProducingFor(RefCount<BodyPipe> &pipe, bool atEof);
 };
 
-// Interface for those who want to consume body content from others.
-// BodyConsumer is expected to register with an existing BodyPipe
-// by calling BodyPipe::setConsumer().
-// One pipe cannot have more than one consumer.
+/** Interface for those who want to consume body content from others.
+ * BodyConsumer is expected to register with an existing BodyPipe
+ * by calling BodyPipe::setConsumer().
+ * One pipe cannot have more than one consumer.
+ */
 class BodyConsumer: virtual public AsyncJob
 {
 public:
@@ -42,8 +43,9 @@ protected:
     void stopConsumingFrom(RefCount<BodyPipe> &pipe);
 };
 
-// Makes raw buffer checkin/checkout interface efficient and exception-safe.
-// Either append or consume operations can be performed on a checkedout buffer.
+/** Makes raw buffer checkin/checkout interface efficient and exception-safe.
+ * Either append or consume operations can be performed on a checkedout buffer.
+ */
 class BodyPipeCheckout
 {
 public:
@@ -69,9 +71,10 @@ private:
     BodyPipeCheckout &operator =(const BodyPipeCheckout &); // prevent assignment
 };
 
-// Connects those who produces message body content with those who
-// consume it. For example, connects ConnStateData with FtpStateData OR
-// ICAPModXact with HttpStateData.
+/** Connects those who produces message body content with those who
+ * consume it. For example, connects ConnStateData with FtpStateData OR
+ * ICAPModXact with HttpStateData.
+ */
 class BodyPipe: public RefCountable
 {
 public: