489913 - Better documentation for signature/vCard attributes in nsIMsgIdentity.idl

Status: RESOLVED FIXED

(MailNews Core :: Backend, defect)

Description

[rsx11m]

This is trivial (no code changes, just comments) but should be fixed to avoid confusion. While the comments for the new attributes introduced in bug 324495 may not have been optimal, the drive-by changes made in bug 167319 introduced a wrong reference and made the values of the boolean pref ambiguous. I can imagine that signature-related extensions will need to be updated, where it may be tricky to figure out what those attributes mean based on the current comments. Thus, I'm trying to get it right in the third attempt now. I've also looked into the related signature/vCard attributes, but not into any of the attributes used outside of that scope which may not be documented yet.

Comment 1

[rsx11m]

Attachment: Proposed changes

This simple patch corrects and modifies the signature-related comments to be more informative, and also adds a comment for the escapedVCard attribute. It doesn't modify any attribute or function. I'm not certain if a new UUID has to be generated to ensure that the changes are correctly recognized, but I figured it cannot hurt.

Comment 2

[David :Bienvenu]

Comment on attachment 374386 [details] [diff] [review]
Proposed changes

you definitely don't want to rev the UUID here. Other than that, sr=me

Comment 3

[rsx11m]

Attachment: Proposed changes (v2) [Checkin: Comment 6]

Thanks, that was quick. Revised version without changing the UUID.

Comment 4

[Karsten Düsterloh]

Comment on attachment 374390 [details] [diff] [review]
Proposed changes (v2)
[Checkin: Comment 6]

Wow, I never was aware what show-jumping course my plain text sig has to hop through... ;-)

Comment 5

[rsx11m]

:-)

Push for comm-central, please.

Comment 6

[Serge Gautherie (:sgautherie)]

Comment on attachment 374390 [details] [diff] [review]
Proposed changes (v2)
[Checkin: Comment 6]


http://hg.mozilla.org/comm-central/rev/f1d77e552f89