Added class description comments.

network/cache/nu/include/nsCacheTrace.h

@@ -15,15 +15,17 @@
  * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
  * Reserved.
  */
+
+/* created 02/02/98.
+ * nsCacheTrace is a silly little class to extract trace 
+ * related functionality. I created this class to make it easier to
+ * change that at one place. In release mode this shouldn't even be there.
+ * I still have to make some changes on the calls to default to noop
+ * in release. -Gagan Saksena 09/15/98 
+ */
 #ifndef _nsCacheTrace_H_
 #define _nsCacheTrace_H_
-/* 
-* nsCacheTrace
-*
-* Gagan Saksena
-* 02/02/98
-* 
-*/
+
 #ifndef CRLF
 #	define CRLF "\r\n"
 #endif

network/cache/nu/include/nsFFEntry.h

@@ -16,13 +16,18 @@
  * Reserved.
  */
 
+/* This is part of the Flat-file cache architecture. The nsFFEntry class 
+ * represents a single entry in the TOC. All io operations take place 
+ * through the FFEntry's read and write functions. An entry may comprise
+ * of one or more objects which are blocks of data spread across the flat 
+ * file.  - Gagan Saksena 09/15/98 */
+
 #ifndef nsFFEntry_h__
 #define nsFFEntry_h__
 
+
 #include "nsFFObject.h"
 //#include "nsISupports.h"
-/** An FFEntry consists of several objects, all io takes place 
-  * through the FFEntry's read and write functions */
 
 class nsFFEntry//: public nsISupports
 {

network/cache/nu/include/nsFFObject.h

@@ -16,6 +16,11 @@
  * Reserved.
  */
 
+/* The nsFFObject class represent a single object block that is the smallest 
+ * page unit on the flat file. This class is part of the flat file cache architecture.
+ * It consists of the offset of the block and the size in use. 
+ * -Gagan Saksena 09/15/98 */
+
 #ifndef nsFFObject_h__
 #define nsFFObject_h__
 

network/cache/nu/include/nsFlatFile.h

@@ -16,6 +16,7 @@
  * Reserved.
  */
 
+/* A class to handle flat file storage mechanism -Gagan Saksena 09/15/98 */
 #ifndef nsFlatFile_h__
 #define nsFlatFile_h__
 
@@ -38,7 +39,6 @@
 #endif
 #endif
 
-/** A class to handle flat file storage mechanism */
 static const PRUint32 kPAGE_SIZE =4096; 
 
 class nsFlatFile //: public nsISupports

network/cache/nu/include/nsTOC.h

@@ -16,6 +16,11 @@
  * Reserved.
  */
 
+/* This is the TOC or the Table of Contents for the flat file. This class 
+ * is part of the flat file cache architecture. The first entry in the TOC 
+ * is reserved for the list of free objects.
+ * -Gagan Saksena 09/15/98 
+ */
 #ifndef nsTOC_h__
 #define nsTOC_h__
 

network/cache/nu/include/nsTimeIt.h

@@ -1,5 +1,29 @@
-/* A class to time excursion events */
-/* declare an object of this class within the scope to be timed. */
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+/* A class to time excursion events. Declare an object of this class 
+ * within the scope to be timed. 
+ * - Gagan Saksena 09/15/98
+ */
+
+#ifndef nsTimeIt_h__
+#define nsTimeIt_h__
+
 #include "prtypes.h"
 #include "prinrval.h"
 
@@ -22,4 +46,7 @@ inline
 nsTimeIt::~nsTimeIt()
 {
     dest = PR_IntervalToMicroseconds(PR_IntervalNow()-t);
-}
+}
+
+#endif // nsTimeIt_h__
+