275106 - Add Javadoc comments to all Java files

Status: RESOLVED FIXED

(Core Graveyard :: Java to XPCOM Bridge, defect)

Description

[jhp (no longer active)]

Need to add Javadoc comments to the Java classes and methods.  For the most
part, the comments will be very similar to what is already in the C headers.

Comment 1

[jhp (no longer active)]

Attachment: patch

Comment 2

[Christian :Biesinger (don't email me, ping me on IRC)]

Comment on attachment 168991 [details] [diff] [review]
patch

+   * @param persistent  <code>true</code>

this is an array...

oh, is this to turn it into an out param? I think you should mention that...
(i.e. that it must not be null, and have a length of 1, and that it will be
filled in by getFile).

People using initEmbedding need/must not call initXPCOM, right (ok... guess
initEmbedding's comment says so already (.."XPCOM is started"..))

+   * @exception XPCOMException <ul>
+   *	   <il>

not <li>?

Comment 3

[Darin Fisher]

Comment on attachment 168991 [details] [diff] [review]
patch

r=darin

but, you're the module owner, so there's no need for you to ask for reviews on
comment changes in the future ;)