Added LXR comments.

rdf/base/public/nsIRDFCursor.h

@@ -16,6 +16,13 @@
  * Reserved.
  */
 
+/*
+
+  Interfaces for RDF cursors, including nsIRDFCursor,
+  nsIRDFAssertionCursor, nsIRDFArcsInCursor, and nsIRDFArcsOutCursor.
+
+ */
+
 #ifndef nsIRDFCursor_h__
 #define nsIRDFCursor_h__
 

rdf/base/public/nsIRDFDataBase.h

@@ -16,6 +16,13 @@
  * Reserved.
  */
 
+/*
+
+  RDF data base interface. An RDF database aggregates individual RDF
+  data sources.
+
+ */
+
 #ifndef nsIRDFDataBase_h__
 #define nsIRDFDataBase_h__
 

rdf/base/public/nsIRDFDataSource.h

@@ -16,6 +16,13 @@
  * Reserved.
  */
 
+/*
+
+  The RDF data source interface. An RDF data source presents a
+  graph-like interface to a back-end service.
+
+ */
+
 #ifndef nsIRDFDataSource_h__
 #define nsIRDFDataSource_h__
 

rdf/base/public/nsIRDFNode.h

@@ -16,6 +16,13 @@
  * Reserved.
  */
 
+/*
+
+  RDF node interfaces, including nsIRDFNode, nsIRDFResource, and
+  nsIRDFLiteral. Nodes are the elements that appear in RDF graphs.
+
+ */
+
 #ifndef nsIRDFNode_h__
 #define nsIRDFNode_h__
 

rdf/base/public/nsIRDFObserver.h

@@ -16,6 +16,13 @@
  * Reserved.
  */
 
+/*
+
+  The RDF data source observer interface. Data source observers are
+  notified when the contents of the graph change.
+
+ */
+
 #ifndef nsIRDFObserver_h__
 #define nsIRDFObserver_h__
 

rdf/base/public/nsIRDFResourceFactory.h

@@ -16,6 +16,14 @@
  * Reserved.
  */
 
+
+/*
+
+  The RDF resource factory interface. A resource factory produces
+  nsIRDFResource objects for a specified URI prefix.
+
+ */
+
 #ifndef nsIRDFResourceFactory_h__
 #define nsIRDFResourceFactory_h__
 

rdf/base/public/nsIRDFService.h

@@ -16,18 +16,7 @@
  * Reserved.
  */
 
-#ifndef nsIRDFService_h__
-#define nsIRDFService_h__
-
-#include "nscore.h"
-#include "nsISupports.h"
-class nsIRDFDataBase;
-class nsIRDFDataSource;
-class nsIRDFLiteral;
-class nsIRDFResource;
-class nsIRDFResourceFactory;
-
-/**
+/*
 
   The RDF service interface. This is a singleton object, and should be
   obtained from the <tt>nsServiceManager</tt>.
@@ -43,6 +32,17 @@ class nsIRDFResourceFactory;
 
  */
 
+#ifndef nsIRDFService_h__
+#define nsIRDFService_h__
+
+#include "nscore.h"
+#include "nsISupports.h"
+class nsIRDFDataBase;
+class nsIRDFDataSource;
+class nsIRDFLiteral;
+class nsIRDFResource;
+class nsIRDFResourceFactory;
+
 class nsIRDFService : public nsISupports {
 public:
 

rdf/base/public/nsIRDFXMLSource.h

@@ -16,6 +16,13 @@
  * Reserved.
  */
 
+/*
+
+  The RDF/XML source interface. An RDF/XML source is capable of
+  producing serialized RDF/XML to an output stream.
+
+ */
+
 #ifndef nsIRDFXMLSource_h__
 #define nsIRDFXMLSource_h__
 

rdf/base/src/nsDataBase.cpp

@@ -16,19 +16,11 @@
  * Reserved.
  */
 
-#include "nsIRDFCursor.h"
-#include "nsIRDFNode.h"
-#include "nsIRDFDataBase.h"
-#include "nsISupportsArray.h"
-#include "nsRepository.h"
-#include "nsVoidArray.h"
-#include "prlog.h"
-
 /*
 
   A simple "database" implementation. An RDF database is just a
-  "strategy" pattern for combining individual data sources into a
-  collective graph.
+  strategy for combining individual data sources into a collective
+  graph.
 
 
   1) A database is a sequence of data sources. The set of data sources
@@ -46,6 +38,14 @@
 
 */
 
+#include "nsIRDFCursor.h"
+#include "nsIRDFNode.h"
+#include "nsIRDFDataBase.h"
+#include "nsISupportsArray.h"
+#include "nsRepository.h"
+#include "nsVoidArray.h"
+#include "prlog.h"
+
 static NS_DEFINE_IID(kIRDFArcsInCursorIID,    NS_IRDFARCSINCURSOR_IID);
 static NS_DEFINE_IID(kIRDFArcsOutCursorIID,   NS_IRDFARCSOUTCURSOR_IID);
 static NS_DEFINE_IID(kIRDFAssertionCursorIID, NS_IRDFASSERTIONCURSOR_IID);

rdf/base/src/nsDefaultResourceFactory.cpp

@@ -16,6 +16,14 @@
  * Reserved.
  */
 
+/*
+
+  The default resource factory implementation. This resource factory
+  produces nsIRDFResource objects for any URI prefix that is not
+  covered by some other factory.
+
+ */
+
 #include "nsIRDFNode.h"
 #include "nsIRDFResourceFactory.h"
 #include "nsIRDFService.h"

rdf/base/src/nsRDFBaseDataSources.h

@@ -16,33 +16,29 @@
  * Reserved.
  */
 
-// This header file just contains prototypes for the factory methods
-// for "builtin" data sources that are included in rdf.dll. Each of
-// these data sources is exposed to the external world via its CID in
-// ../include/nsRDFCID.h.
+/*
+
+  This header file just contains prototypes for the factory methods
+  for "builtin" data sources that are included in rdf.dll.
+
+  Each of these data sources is exposed to the external world via its
+  CID in ../include/nsRDFCID.h.
+
+*/
 
 #ifndef nsBaseDataSources_h__
 #define nsBaseDataSources_h__
 
 #include "nsError.h"
-
 class nsIRDFDataSource;
 class nsIRDFDataBase;
 
-
-// in nsMemoryDataSource.cpp
-
-nsresult NS_NewRDFMemoryDataSource(nsIRDFDataSource** result);
-
 // in nsInMemoryDataSource.cpp
-
 nsresult NS_NewRDFInMemoryDataSource(nsIRDFDataSource** result);
 
-// in nsSimpleDataBase.cpp
-nsresult NS_NewRDFSimpleDataBase(nsIRDFDataBase** result);
-
 // in nsDataBase.cpp
 nsresult NS_NewRDFDataBase(nsIRDFDataBase** result);
+
 #endif // nsBaseDataSources_h__
 
 

rdf/base/src/rdfutil.cpp

@@ -17,6 +17,14 @@
  * Netscape Communications Corporation.  All Rights Reserved.
  */
 
+/*
+
+  Implementations for a bunch of useful RDF utility routines.  Many of
+  these will eventually be exported outside of RDF.DLL via the
+  nsIRDFService interface.
+
+ */
+
 #include "nsIRDFCursor.h"
 #include "nsIRDFDataBase.h"
 #include "nsIRDFNode.h"

rdf/base/src/rdfutil.h

@@ -18,9 +18,13 @@
  */
 
 
-// XXX This should really be a first-class utility interface that's
-// available via the service manager. The only reason that I'm not
-// making it so right now is to keep stuff light and easy to hack.
+/*
+
+  A bunch of useful RDF utility routines.  Many of these will
+  eventually be exported outside of RDF.DLL via the nsIRDFService
+  interface.
+
+ */
 
 #ifndef rdfutil_h__
 #define rdfutil_h__

rdf/build/nsRDFCID.h

@@ -16,6 +16,13 @@
  * Reserved.
  */
 
+/*
+
+  XPCOM Class IDs for RDF objects that can be constructed via the RDF
+  factory.
+
+ */
+
 #ifndef nsRDFCID_h__
 #define nsRDFCID_h__
 

rdf/build/nsRDFFactory.cpp

@@ -16,6 +16,12 @@
  * Reserved.
  */
 
+/*
+
+  The RDF factory implementation.
+
+ */
+
 #include "nsISupports.h"
 #include "nsIFactory.h"
 #include "nsIRDFContentSink.h"