1209919 - Improving naming and comments in StructuredCloneHelper

Status: RESOLVED FIXED

(Core :: DOM: Core & HTML, defect)

Description

[Andrea Marchesini [:baku]]

sfink gave me extremely useful hints about naming and comments in StructuredCloneHelper.

Comment 1

[Andrea Marchesini [:baku]]

Attachment: renaming.patch

Comment 2

[Olli Pettay [:smaug]]

+  // Like Write() but it support the transferring of objects.
supports

+  // The parent object is set internally just during the Read(). This method
+  // can be used by custom read functions to retrieve it.
That sounds like the parent object has something to do with CustomReadHandler.
Could you perhaps drop 'custom' from the comment


// Implementations of the virtual methods to allow cloning of DOM data
Is a bit vague "DOM data". 
Perhaps something like
"Implementations of the virtual methods to allow cloning  of objects which JS engine itself doesn't clone."

+  // These 2 static methods are useful to read/write fully serializable objects.
+  // They can be used by custom StructuredCloneHolderBase classes to
+  // serialize standard objects such as ImageData, CryptoKey, RTCCertificate,
+  // etc."
Why the word "standard" there.


+  ContextSupport mSupportedContexts;
I would probably call it mSupportedContext (without the 's'), but either way.

Comment 3

[Andrea Marchesini [:baku]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/2f694f107db9

Comment 4

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/2f694f107db9