From 057ad684d89a6e47e64c5c6ba7760f7c76de9753 Mon Sep 17 00:00:00 2001
From: Jon Siwek <jsiwek@ncsa.illinois.edu>
Date: Fri, 8 Apr 2011 12:30:06 -0500
Subject: [PATCH] Add brief descriptions for classes involved in generation of
 script docs.

---
 src/BroDoc.h    | 4 ++++
 src/BroDocObj.h | 5 ++++-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/BroDoc.h b/src/BroDoc.h
index 1096a030f3..83526bfef2 100644
--- a/src/BroDoc.h
+++ b/src/BroDoc.h
@@ -8,6 +8,10 @@
 
 #include "BroDocObj.h"
 
+/**
+ * This class is used to gather all data relevant to the automatic generation
+ * of a reStructuredText (reST) document from a given Bro script.
+ */
 class BroDoc {
 public:
 	/**
diff --git a/src/BroDocObj.h b/src/BroDocObj.h
index a6f497db50..1c6c99af4a 100644
--- a/src/BroDocObj.h
+++ b/src/BroDocObj.h
@@ -7,6 +7,10 @@
 
 #include "ID.h"
 
+/**
+ * This class wraps a Bro script identifier, providing methods relevant
+ * to automatic generation of reStructuredText (reST) documentation for it.
+ */
 class BroDocObj {
 public:
 	/**
@@ -97,7 +101,6 @@ public:
 	 */
 	int LongestShortDescLen() const;
 
-
 protected:
 	std::list<std::string>* reST_doc_strings;
 	std::list<std::string> short_desc;