Closed Bug 64327 Opened 25 years ago Closed 24 years ago

nsISelection.idl and nsIDOMRange.idl need comments

Categories

(Core Graveyard :: Embedding: APIs, defect, P1)

defect

Tracking

(Not tracked)

VERIFIED FIXED
mozilla0.9.1

People

(Reporter: jud, Assigned: anthonyd)

References

Details

(Whiteboard: FIX IN HAND)

Attachments

(5 files)

From http://www.mozilla.org/projects/embedding/apiReviewNotes.html#nsISelection. - remove nsISelectionListener forward declarion (and it's idl include) from nsISelection.idl. - same for nsIEnumerator.
Updating QA Contact
QA Contact: jrgm → mdunn
Do we plan to add documentation or is it enough for the moment that I check this in with just the changes requested?
let's do some documentation too :-). At least method usage stuff.
Blocks: 70229
r=valeski
Why were the selection owners not cced on this bug? Doing so....
In addition, some of those comments are wrong. Anthonyd should comment the interface.
sr=vidur for the removal of the unnecessary includes and forward declarations. As Simon mentions, anthonyd should update the comments.
Okay, I'll checkin when the tree permits and reassign so the comments can be corrected.
Assignee: adamlock → anthonyd
Target Milestone: --- → mozilla0.9
New version is checked in, reassigning to anthonyd@netscape.com for documentation corrections.
*** Bug 29246 has been marked as a duplicate of this bug. ***
summary and status summary
Summary: nsISelection.idl is dirty. → nsISelection.idl and nsIRange.idl need comments
Whiteboard: waiting on akkana's and mjudge's carpools
moving to mozilla1.0
Keywords: correctness
Target Milestone: mozilla0.9 → mozilla1.0
Priority: -- → P3
moving to 0.9, highly requested and an easy kill anthonyd
Status: NEW → ASSIGNED
Target Milestone: mozilla1.0 → mozilla0.9
Moving to mozilla0.9.1.
Target Milestone: mozilla0.9 → mozilla0.9.1
Correction: Changing QA contact for the Embed API bugs to David Epstein.
QA Contact: mdunn → depstein
OS: Linux → All
Priority: P3 → P1
Hardware: PC → All
there is no nsIRange.idl, i think it is supposed to read nsIDOMRange.idl ;-) anthonyd
Summary: nsISelection.idl and nsIRange.idl need comments → nsISelection.idl and nsIDOMRange.idl need comments
Whiteboard: waiting on akkana's and mjudge's carpools → FIX IN HAND
Comments: setStart and setEnd have comments that refer to "the new focused node". Do they really affect the focused node? + /** + * Select a node and its contents. + * @param n The Node to select. + */ void selectNode(in nsIDOMNode n); What does 'selecting' a node do? Does it add the node to the range, replace the contents of the range with this node, or make the node appear selected to the user? + /** + * Select the contents within a node. + * @param n Node to select from. + */ void selectNodeContents(in nsIDOMNode n); ditto. + /** + * Compare the boundary-points of two Ranges in a document. + * @param how parameter from CompareHow group, how the boundary points + * are to be compared. + * @param srcRange the range which will have its boundary points compared. + */ long compareBoundaryPoints(in unsigned short how, in nsIDOMRange srcRange); What is the meaning of the |long| return value? + /** + * Removes the contents of a Range from the containing document or document + * fragment without returning a reference to the removed content. + * Return Value: -1, 0 or 1 depending on whether the corresponding + * boundary-point of the Range is before, equal to, or after the + * corresponding boundary-point of sourceRange. + */ void deleteContents(); You talk about the return value, but the method returns void. Looks like the second half of the comment was mean for compareBoundaryPoints.
thanks for the comments simon, i wll re attach with your sugesstions anthonyd
checked in comments anthonyd
Status: ASSIGNED → RESOLVED
Closed: 24 years ago
Resolution: --- → FIXED
1) Comments in nsISelection.idl & nsIDOMRange.idl 2) Forward declaration nsISelectionListener removed from nsISelection.idl. No related #include. 3) Same for nsIEnumerator.idl
Status: RESOLVED → VERIFIED
Product: Core → Core Graveyard
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: