sr=alecf. javadoc'ing comments and changing a param name

xpcom/ds/nsIObserver.idl

@@ -22,20 +22,27 @@
 
 #include "nsISupports.idl"
 
+/**
+ * This interface is implemented by an object that needs
+ * to observe an event corresponding to a change in a 
+ * topic for a subject.
+ */
+
 [scriptable, uuid(DB242E01-E4D9-11d2-9DDE-000064657374)]
 interface nsIObserver : nsISupports {
 
-	/*------------------------------- Observe ----------------------------------
+   /**
-    | Called when aTopic changes for aSubject (presumably; it is actually      |
+    * Called if the topic changes for the subject. If you expect 
-    | called whenever anyone calls nsIObserverService::Notify for aTopic).     |
+    * multiple topics/subjects, the impl is responsible for filtering.
-    |                                                                          |
+    *
-    | Implement this in your class to handle the event appropriately.  If      |
+    * @param aSubject - the event specific data that has changed.
-    | your observer objects can respond to multiple topics and/or subjects,    |
+    * @param aTopic   - indicates the event that has changed.
-    | then you will have to filter accordingly.                                |
+    * @param aData    - out of band data specific to the topic/
-	--------------------------------------------------------------------------*/
+    *                   subject event.
+    */
     void Observe( in nsISupports aSubject,
 				  in wstring     aTopic,
-				  in wstring     someData );
+				  in wstring     aData );
 
 };