243243 - nsTXTToHTMLConverter.cpp could use some documentation

Status: VERIFIED FIXED

(Core :: Networking, defect)

Description

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

Comment 1

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

Attachment: patch

Comment 2

[Stephen Donner [:stephend] Not actively reading bugmail]

+ * OVERVIEW OF THE FUNCTIONING:

shouldn't that read 'OVERVIEW OF FUNCTIONALITY:'?

Comment 3

[Darin Fisher]

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

with whatever other tweaks you wish to make.  thanks for the patch! :-)

Comment 4

[timeless]

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

>+ * This class stores an array of tokens that should be replaced by something,
>+ * or something -should be- prepended.
_that should be_, or _to be_

>+ * XXX this seems suboptimal. this means that that will only work for

'that that' would be marked as bad by a decent spellchecker. might i suggest no
using mozilla's? :)

Comment 5

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

(In reply to comment #2)
> + * OVERVIEW OF THE FUNCTIONING:
> 
> shouldn't that read 'OVERVIEW OF FUNCTIONALITY:'?

I meant to express "OVERVIEW OF HOW THIS CLASS WORKS"
guess I'll use this text


I picked "that this design" for "that that"

checked in

Comment 6

[Stephen Donner [:stephend] Not actively reading bugmail]

Verified FIXED using LXR.