Add introductory comments to the files in mfbt/ that aren't copied from elsewhere, to facilitate easier MXR directory skimming. No bug, r=lumpy
authorJeff Walden <jwalden@mit.edu>
Wed, 28 Dec 2011 10:48:54 -0600
changeset 86357 ad85a745d2fbf9a34c5d32cd3471cc6635c79ccf
parent 86356 24bbd63d12d21423a47af6370326e86886a3d405
child 86358 29dc9bdea5a90b0a85efeaa385219b30fbd34849
push id129
push userffxbld
push dateFri, 20 Apr 2012 19:40:49 +0000
treeherdermozilla-release@5bcfa0da3be9 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerslumpy
milestone12.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Add introductory comments to the files in mfbt/ that aren't copied from elsewhere, to facilitate easier MXR directory skimming. No bug, r=lumpy
mfbt/Assertions.h
mfbt/RangedPtr.h
mfbt/RefPtr.h
mfbt/Util.h
--- a/mfbt/Assertions.h
+++ b/mfbt/Assertions.h
@@ -33,16 +33,18 @@
  * use your version of this file under the terms of the MPL, indicate your
  * decision by deleting the provisions above and replace them with the notice
  * and other provisions required by the GPL or the LGPL. If you do not delete
  * the provisions above, a recipient may use your version of this file under
  * the terms of any one of the MPL, the GPL or the LGPL.
  *
  * ***** END LICENSE BLOCK ***** */
 
+/* Implementations of runtime and static assertion macros for C and C++. */
+
 #ifndef mozilla_Assertions_h_
 #define mozilla_Assertions_h_
 
 #include "mozilla/Types.h"
 
 /*
  * MOZ_STATIC_ASSERT may be used to assert a condition *at compile time*.  This
  * can be useful when you make certain assumptions about what must hold for
--- a/mfbt/RangedPtr.h
+++ b/mfbt/RangedPtr.h
@@ -33,16 +33,21 @@
  * use your version of this file under the terms of the MPL, indicate your
  * decision by deleting the provisions above and replace them with the notice
  * and other provisions required by the GPL or the LGPL. If you do not delete
  * the provisions above, a recipient may use your version of this file under
  * the terms of any one of the MPL, the GPL or the LGPL.
  *
  * ***** END LICENSE BLOCK ***** */
 
+/*
+ * Implements a smart pointer asserted to remain within a range specified at
+ * construction.
+ */
+
 #ifndef mozilla_RangedPtr_h_
 #define mozilla_RangedPtr_h_
 
 #include "mozilla/Assertions.h"
 #include "mozilla/Attributes.h"
 #include "mozilla/Util.h"
 
 namespace mozilla {
--- a/mfbt/RefPtr.h
+++ b/mfbt/RefPtr.h
@@ -33,26 +33,24 @@
  * use your version of this file under the terms of the MPL, indicate your
  * decision by deleting the provisions above and replace them with the notice
  * and other provisions required by the GPL or the LGPL. If you do not delete
  * the provisions above, a recipient may use your version of this file under
  * the terms of any one of the MPL, the GPL or the LGPL.
  *
  * ***** 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;
 template<typename T> class RefPtr;
 template<typename T> class TemporaryRef;
 template<typename T> class OutParamRef;
 template<typename T> OutParamRef<T> byRef(RefPtr<T>&);
 
--- a/mfbt/Util.h
+++ b/mfbt/Util.h
@@ -32,16 +32,21 @@
  * use your version of this file under the terms of the MPL, indicate your
  * decision by deleting the provisions above and replace them with the notice
  * and other provisions required by the GPL or the LGPL. If you do not delete
  * the provisions above, a recipient may use your version of this file under
  * the terms of any one of the MPL, the GPL or the LGPL.
  *
  * ***** 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_
 
 #include "mozilla/Assertions.h"
 #include "mozilla/Attributes.h"
 #include "mozilla/Types.h"
 
 #ifdef __cplusplus