Add introductory comments to the files in mfbt/ that aren't copied fr…

…om elsewhere, to facilitate easier MXR directory skimming. No bug, r=lumpy
Brli · Dec 28, 2011 · d76584f · d76584f
1 parent a89d939
commit d76584f
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/mfbt/Assertions.h b/mfbt/Assertions.h
@@ -38,6 +38,8 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* Implementations of runtime and static assertion macros for C and C++. */
+
 #ifndef mozilla_Assertions_h_
 #define mozilla_Assertions_h_
 

diff --git a/mfbt/RangedPtr.h b/mfbt/RangedPtr.h
@@ -38,6 +38,11 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/*
+ * Implements a smart pointer asserted to remain within a range specified at
+ * construction.
+ */
+
 #ifndef mozilla_RangedPtr_h_
 #define mozilla_RangedPtr_h_
 

diff --git a/mfbt/RefPtr.h b/mfbt/RefPtr.h
@@ -38,16 +38,14 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* Helpers for defining and using refcounted objects. */
+
 #ifndef mozilla_RefPtr_h_
 #define mozilla_RefPtr_h_
 
 #include "mozilla/Assertions.h"
 #include "mozilla/Attributes.h"
 
-/**
- * Helpers for defining and using refcounted objects.
- */
-
 namespace mozilla {
 
 template<typename T> class RefCounted;

diff --git a/mfbt/Util.h b/mfbt/Util.h
@@ -37,6 +37,11 @@
  *
  * ***** END LICENSE BLOCK ***** */
 
+/*
+ * Miscellaneous uncategorized functionality.  Please add new functionality to
+ * new headers, or to other appropriate existing headers, not here.
+ */
+
 #ifndef mozilla_Util_h_
 #define mozilla_Util_h_