From: Stephen Morris <stephen@isc.org>
Date: Fri, 14 Dec 2012 14:47:10 +0000 (+0000)
Subject: [2526] Modified a couple of method header comments
X-Git-Tag: bind10-1.0.0-beta-release~19^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3759773a821827277aa2c8d457dd6fe63f1daf75;p=thirdparty%2Fkea.git

[2526] Modified a couple of method header comments
---

diff --git a/src/lib/dhcp/option_definition.h b/src/lib/dhcp/option_definition.h
index 4c94a0f410..9f6bef2c99 100644
--- a/src/lib/dhcp/option_definition.h
+++ b/src/lib/dhcp/option_definition.h
@@ -50,21 +50,21 @@ typedef boost::shared_ptr<OptionDefinition> OptionDefinitionPtr;
 
 /// @brief Forward declaration to OptionInt.
 ///
-/// This forward declaration is needed to access OptionInt class
-/// without having to include option_int.h header. This is because
-/// this header includes libdhcp++.h and this causes circular
-/// inclusion between libdhcp++.h, option_definition.h and
+/// This forward declaration is needed to access the OptionInt class without
+/// having to include the option_int.h header file. It is required because
+/// this header includes libdhcp++.h, and including option_int.h would cause
+/// circular inclusion between libdhcp++.h, option_definition.h and
 /// option6_int.h.
 template<typename T>
 class OptionInt;
 
 /// @brief Forward declaration to OptionIntArray.
 ///
-/// This forward declaration is needed to access OptionIntArray class
-/// without having to include option_int_array.h header. This is because
-/// this header includes libdhcp++.h and this causes circular
-/// inclusion between libdhcp++.h, option_definition.h and
-/// option_int_array.h.
+/// This forward declaration is needed to access the OptionIntArray class
+/// without having to include the option_int_array.h header file. It is
+/// required because this header includes libdhcp++.h, and including
+/// option_int_array.h would cause circular inclusion between libdhcp++.h,
+/// option_definition.h and option_int_array.h.
 template<typename T>
 class OptionIntArray;