Closed Bug 760455 Opened 12 years ago Closed 6 years ago

Document nsIAutoCompleteInput interface better

Categories

(Toolkit :: Autocomplete, defect)

defect
Not set
normal

Tracking

()

RESOLVED INACTIVE

People

(Reporter: sgautherie, Unassigned)

References

()

Details

{
84   /*
85    * The number of autocomplete session to search
86    */
87   readonly attribute unsigned long searchCount;
88   
89   /*
90    * Get the name of one of the autocomplete search session objects
91    */
92   ACString getSearchAt(in unsigned long index);
}

'searchCount' always exists as a count: it defaults to 0.

But related 'getSearchAt()' doesn't explicitly specify what to expect if the index is invalid (as in < 0 or >= searchCount) :-/
That should be documented.

***

Fwiw,

http://mxr.mozilla.org/comm-central/source/mozilla/toolkit/content/widgets/autocomplete.xml
{
178           return this.mSearchNames[aIndex];
}
will implicitly return |undefined|.

Yet, in SeaMonkey bug 747668, I (initially) thought this method should rather
|throw Components.results.NS_ERROR_INVALID_ARG;|.

*****

Who can decide?

NB: Other methods may be in the same case...
Per policy at https://wiki.mozilla.org/Bug_Triage/Projects/Bug_Handling/Bug_Husbandry#Inactive_Bugs. If this bug is not an enhancement request or a bug not present in a supported release of Firefox, then it may be reopened.
Status: NEW → RESOLVED
Closed: 6 years ago
Resolution: --- → INACTIVE
You need to log in before you can comment on or make changes to this bug.