add comments to IDL files so they show up in LXR

add new newsgroup attribute to offline interface

mailnews/news/public/nsIMsgNewsArticleList.idl

@@ -1,49 +0,0 @@
-/* -*- Mode: C; tab-width: 4; 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.
- */
-
-#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)
- */
-[object, uuid(E628ED19-9452-11d2-B7EA-00805F05FFA5)]
-interface nsIMsgNewsArticleList : nsISupports {
-
-/* These calls are used by libnet to determine which articles it ought to
-     get in a big newsgroup. */
-  /* the nsIUnknown will probably hold a ListNewsGroupState
-   * this stuff might really belong on the XOVER stuff, but I'm not sure
-   * -alecf */
-
-
-  void InitAddArticleKeyToGroup();
-  void AddArticleKeyToGroup(in long found_id);
-  void FinishAddArticleKeyToGroup();
-  void GetRangeOfArtsToDownload(out long status,
-                                in long first_message,
-                                in long last_message,
-                                in long maxextra,
-                                out long real_first_message,
-                                out long real_last_message);
-  
-  void AddToKnownArticles(in long first_message, in long last_message);
-  
-};
-

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

@@ -1,46 +0,0 @@
-/* -*- Mode: C; tab-width: 4; 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.
- */
-
-#include "nsISupports.idl"
-
-
-[object, uuid(E628ED19-9452-11d2-B7EA-00805F05FFA5)]
-interface nsIMsgXOVERParser : nsISupports {
-
-  /* The NNTP module of netlib calls these to feed XOVER data to the message
-     library, in response to a news:group.name URL having been opened.
-     If MSG_FinishXOVER() returns a message ID, that message will be loaded
-     next (used for selecting the first unread message in a group after
-     listing that group.)
-
-     depricated:
-     The "out" arguments are (if non-NULL) a file descriptor to write the XOVER
-     line to, followed by a "\n".  This is used by the XOVER-caching code.
-  */
-  /* the XOVER Sink should maintain the ListNewsGroupState */
-  void Init(in string hostname, in string groupname,
-            in long first_message, in long last_message,
-            in long oldest_message, in long newest_message);
-  
-  void Process(in string line, out long status);
-  void ProcessNonXOVER(in string line);
-  void Reset();
-  void Finish(in long status, out long newstatus);
-  void ClearState();
-  
-};