per dmose, use @return for getMessageForHeader doxygen
authorAndrew Sutherland <asutherland@asutherland.org>
Mon, 22 Sep 2008 05:45:53 -0700
changeset 944 d0af9697234b9a497a5b964b368ec41b68d8b9eb
parent 943 92bf7e5a505168b8f4a370f1a40de004dc392ce2
child 945 65e60597a8f478b9de98af81d41eba4bfdb64d43
push idunknown
push userunknown
push dateunknown
per dmose, use @return for getMessageForHeader doxygen
modules/gloda.js
--- a/modules/gloda.js
+++ b/modules/gloda.js
@@ -178,18 +178,22 @@ let Gloda = {
   },
   
   kIndexerIdle: 0,
   kIndexerIndexing: 1,
   kIndexerMoving: 2,
   kIndexerRemoving: 3,
   
   /**
-   * Given an nsIMsgDBHdr, return the gloda message object that corresponds to
-   *  it.  If no such message exists, null is returned.
+   * Lookup a gloda message from an nsIMsgDBHdr.
+   *
+   * @param aMsgHdr The header of the message you want the gloda message for.
+   *
+   * @return the gloda messages that corresponds to the provided nsIMsgDBHdr
+   *    if one exists, null if one cannot be found.
    */
   getMessageForHeader: function gloda_ns_getMessageForHeader(aMsgHdr) {
     return GlodaDatastore.getMessageFromLocation(aMsgHdr.folder.URI,
                                                  aMsgHdr.messageKey);
   },
   
   /**
    * Given one or more full mail addresses (ex: "Bob Smith" <bob@smith.com>),