Here are the commenting conventions we are using for jslib.
Unfortunately the mozilla mail reader has a problem with the white space
so it may look a little funcky.
I think al the interface files should use a simular convention. Comments
take time to write, but this is well invested time.
--pete
JSLIB Example Comment
/****************************************************************
* getProgIDFromCID(aCID) *
* *
* aCID is an argument of string CID Class ID *
* returns string ProgID on success, null on failure *
* Ex: *
* var cid='{2e23e220-60be-11d3-8c4a-000064657374}'; *
* getClassIDFromProgID(cid); *
* *
* outputs: @mozilla.org/file/local;1 *
****************************************************************/
1. method name
2. argument description
3. possible return values
4. an example of useage
5. an example of sdtout if applicable
