add comments to IDL files so they show up in LXR

add new newsgroup attribute to offline interface

mailnews/news/public/nsIMsgNewsArticleList.idl

@@ -16,13 +16,13 @@
  * Reserved.
  */
 
-#include "nsISupports.idl"
-
 /* this interface is basically for the old ListNewsGroupState class
  * (the implementation of this class probably wants to also implement
  * or contain ChangeListener so that it can react to OnAnnouncerGoingAway()
  * to destroy the DBView)
  */
+#include "nsISupports.idl"
+
 [object, uuid(E628ED19-9452-11d2-B7EA-00805F05FFA5)]
 interface nsIMsgNewsArticleList : nsISupports {
 

mailnews/news/public/nsIMsgNewsHost.idl

@@ -15,6 +15,13 @@
  * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
  * Reserved.
  */
+
+/*
+ * An NNTP view of a newshost. Contains everything needed to maintain state
+ * information about an NNTP host. Similar to the old MSG_NewsHost but
+ * is only for protocol-state maintenance.
+ */
+
 #include "nsISupports.idl"
 #include "nsIMsgNewsgroup.idl"
 

mailnews/news/public/nsIMsgNewsgroup.idl

@@ -16,6 +16,14 @@
  * Reserved.
  */
 
+/*
+ * network-oriented interface to newsgroups.
+ * This is similar to the old MSG_NewsFolderInfo but is an interface
+ * only NNTP uses for talking to the news server and maintaining state.
+ *
+ */
+
+
 #include "nsISupports.idl"
 
 [object, uuid(E628ED10-9452-11d2-B7EA-00805F05FFA5)]

mailnews/news/public/nsIMsgOfflineNewsState.h

@@ -6,6 +6,7 @@
 #define __nsIMsgOfflineNewsState_h__
 
 #include "nsISupports.h" /* interface nsISupports */
+#include "nsIMsgNewsgroup.h" /* interface nsIMsgNewsgroup */
 
 /* starting interface nsIMsgOfflineNewsState */
 
@@ -25,6 +26,10 @@ class nsIMsgOfflineNewsState : public nsISupports {
     return iid;
   }
 
+  /* attribute nsIMsgNewsgroup newsgroup; */
+  NS_IMETHOD GetNewsgroup(nsIMsgNewsgroup * *aNewsgroup) = 0;
+  NS_IMETHOD SetNewsgroup(nsIMsgNewsgroup * aNewsgroup) = 0;
+
   /*  Process(out string outputBuffer, in  bufferSize); */
   NS_IMETHOD Process(char **outputBuffer, PRInt32 bufferSize, PRInt32 *_retval) = 0;
 

mailnews/news/public/nsIMsgOfflineNewsState.idl

@@ -16,17 +16,24 @@
  * Reserved.
  */
 
+/*
+ * offline news message state. Interface for old MSG_OfflineNewsArtState
+ */
+
 #include "nsISupports.idl"
+#include "nsIMsgNewsgroup.idl"
 
 [object, uuid(921AC210-96B5-11d2-B7EB-00805F05FFA5)]
 interface nsIMsgOfflineNewsState : nsISupports {
 
+  attribute nsIMsgNewsgroup newsgroup;
     /* outputBuffer is actually
      * a buffer to dump data into, but we normally pass it NET_Socket_Buffer,
      * which is constant. The implementation should only allocate a new
      * buffer if *outputBuffer is NULL.
      */
-    long Process(out string outputBuffer, in long bufferSize);
-    long Interrupt();
+
+  long Process(out string outputBuffer, in long bufferSize);
+  long Interrupt();
 };
 

mailnews/news/public/nsIMsgXOVERParser.idl

@@ -16,6 +16,10 @@
  * Reserved.
  */
 
+/*
+ * XOVER results parser - data pushed into this interface from the NNTP
+ * protocol interface
+ */
 #include "nsISupports.idl"