diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/jsdoc.xml | 4254 |
1 files changed, 1958 insertions, 2296 deletions
diff --git a/docs/jsdoc.xml b/docs/jsdoc.xml index a6a1d0a..94f6911 100644 --- a/docs/jsdoc.xml +++ b/docs/jsdoc.xml @@ -1,2304 +1,1966 @@ <?xml version="1.0"?> <javascript> - <classes> - - <class - name="GLOBALS" - > - <constructor_args></constructor_args> - <constructor_vars> - - </constructor_vars> - - <constructor_detail><![CDATA[]]></constructor_detail> - - <instance-methods> - - </instance-methods> - - <instance-fields> - - </instance-fields> - - <class-methods> - - <method mapped_name="isOurPage"> - <description><![CDATA[]]></description> - <argument_list>(window, matchingURLs)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[main.js]]></value> - - </var> - - </vars> - </method> - - - <method mapped_name="createTransferable"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[clipboard.js]]></value> - - </var> - - </vars> - </method> - - - <method mapped_name="getClipboard"> - <description><![CDATA[returns content of the system clipboard]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[clipboard.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[string with the content of the clipboard or "" if empty. originally from https://developer.mozilla.org/en/Using_the_Clipboard https://wiki.mozilla.org/Labs/Jetpack/JEP/10]]></value> - - </var> - - </vars> - </method> - - - <method mapped_name="initialize"> - <description><![CDATA[]]></description> - <argument_list>(callback)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[main.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - - <method mapped_name="skipThisPage"> - <description><![CDATA[]]></description> - <argument_list>(doc)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[main.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - - - - </class-methods> - - <class-fields> - - - </class-fields> - - <inner-classes> - - </inner-classes> - - - </class> - - <class - name="XMLRPCMessage" - > - <constructor_args></constructor_args> - <constructor_vars> - - </constructor_vars> - - <constructor_detail><![CDATA[]]></constructor_detail> - - <instance-methods> - - <method mapped_name="setMethod"> - <description><![CDATA[]]></description> - <argument_list>(methodName)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[xmlrpc.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="addParameter"> - <description><![CDATA[]]></description> - <argument_list>(data)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[xmlrpc.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="xml"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[xmlrpc.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="dataTypeOf"> - <description><![CDATA[]]></description> - <argument_list>(o)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[xmlrpc.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="doValueXML"> - <description><![CDATA[]]></description> - <argument_list>(type, data)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[xmlrpc.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="doBooleanXML"> - <description><![CDATA[]]></description> - <argument_list>(data)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[xmlrpc.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="doDateXML"> - <description><![CDATA[]]></description> - <argument_list>(data)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[xmlrpc.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="doArrayXML"> - <description><![CDATA[]]></description> - <argument_list>(data)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[xmlrpc.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="doStructXML"> - <description><![CDATA[]]></description> - <argument_list>(data)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[xmlrpc.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getParamXML"> - <description><![CDATA[]]></description> - <argument_list>(type, data)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[xmlrpc.js]]></value> - - </var> - - </vars> - </method> - - </instance-methods> - - <instance-fields> - - </instance-fields> - - <class-methods> - - - - </class-methods> - - <class-fields> - - - </class-fields> - - <inner-classes> - - </inner-classes> - - - </class> - - <class - name="PersistentPageMod" - > - <constructor_args>(window, callback)</constructor_args> - <constructor_vars> - - <var name="filename"> - - <value><![CDATA[persistent-page-mod.js]]></value> - - </var> - - <var name="constructor"> - - <value><![CDATA[]]></value> - - </var> - - </constructor_vars> - - <constructor_detail><![CDATA[]]></constructor_detail> - - <instance-methods> - - <method mapped_name="doMod"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[persistent-page-mod.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="handleEvent"> - <description><![CDATA[]]></description> - <argument_list>(event)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[persistent-page-mod.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="unload"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[persistent-page-mod.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - </instance-methods> - - <instance-fields> - - <field name="window"> - <field-value><![CDATA[window]]></field-value> - <field-description><![CDATA[]]></field-description> - <vars> - - </vars> - </field> - - <field name="callback"> - <field-value><![CDATA[callback]]></field-value> - <field-description><![CDATA[]]></field-description> - <vars> - - </vars> - </field> - - <field name="REPLACE_DELAY"> - <field-value><![CDATA[100]]></field-value> - <field-description><![CDATA[]]></field-description> - <vars> - - </vars> - </field> - - </instance-fields> - - <class-methods> - - - - </class-methods> - - <class-fields> - - - </class-fields> - - <inner-classes> - - </inner-classes> - - - </class> - - <class - name="Logger" - > - <constructor_args>(store, abbsMap)</constructor_args> - <constructor_vars> - - <var name="filename"> - - <value><![CDATA[logger.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </constructor_vars> - - <constructor_detail><![CDATA[]]></constructor_detail> - - <instance-methods> - - <method mapped_name="addLogRecord"> - <description><![CDATA[]]></description> - <argument_list>(that)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[logger.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getLength"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[logger.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getBugzillaAbbr"> - <description><![CDATA[]]></description> - <argument_list>(url)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[logger.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="timeSheetRecordsPrinter"> - <description><![CDATA[]]></description> - <argument_list>(body, records)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[logger.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="createBlankPage"> - <description><![CDATA[]]></description> - <argument_list>(ttl, bodyBuildCB)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[logger.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="generateTimeSheet"> - <description><![CDATA[]]></description> - <argument_list>(body)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[logger.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - </instance-methods> - - <instance-fields> - - </instance-fields> - - <class-methods> - - - - </class-methods> - - <class-fields> - - - </class-fields> - - <inner-classes> - - </inner-classes> - - - </class> - - <class - name="Color" - > - <constructor_args>(r, g, b)</constructor_args> - <constructor_vars> - - <var name="filename"> - - <value><![CDATA[color.js]]></value> - - </var> - - </constructor_vars> - - <constructor_detail><![CDATA[]]></constructor_detail> - - <instance-methods> - - <method mapped_name="update"> - <description><![CDATA[]]></description> - <argument_list>(r, g, b)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[color.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="hs"> - <description><![CDATA[]]></description> - <argument_list>(nStr)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[color.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="toString"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[color.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="hsl"> - <description><![CDATA[Converts an RGB color value to HSL. Conversion formula adapted from + <classes> + <class name="GLOBALS"> + <constructor_args></constructor_args> + <constructor_vars></constructor_vars> + <constructor_detail> + <![CDATA[]]> +</constructor_detail> + <instance-methods></instance-methods> + <instance-fields></instance-fields> + <class-methods> + <method mapped_name="isOurPage"> + <description> + <![CDATA[]]> +</description> + <argument_list>(window, matchingURLs)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[main.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="createTransferable"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[clipboard.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getClipboard"> + <description> + <![CDATA[returns content of the system clipboard]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[clipboard.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[string with the content of the clipboard or "" if empty. originally from https://developer.mozilla.org/en/Using_the_Clipboard https://wiki.mozilla.org/Labs/Jetpack/JEP/10]]> +</value> + </var> + </vars> + </method> + <method mapped_name="initialize"> + <description> + <![CDATA[]]> +</description> + <argument_list>(callback)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[main.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="skipThisPage"> + <description> + <![CDATA[]]> +</description> + <argument_list>(doc)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[main.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + </class-methods> + <class-fields></class-fields> + <inner-classes></inner-classes> + </class> + <class name="XMLRPCMessage"> + <constructor_args></constructor_args> + <constructor_vars></constructor_vars> + <constructor_detail> + <![CDATA[]]> +</constructor_detail> + <instance-methods> + <method mapped_name="setMethod"> + <description> + <![CDATA[]]> +</description> + <argument_list>(methodName)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[xmlrpc.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="addParameter"> + <description> + <![CDATA[]]> +</description> + <argument_list>(data)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[xmlrpc.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="xml"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[xmlrpc.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="dataTypeOf"> + <description> + <![CDATA[]]> +</description> + <argument_list>(o)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[xmlrpc.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="doValueXML"> + <description> + <![CDATA[]]> +</description> + <argument_list>(type, data)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[xmlrpc.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="doBooleanXML"> + <description> + <![CDATA[]]> +</description> + <argument_list>(data)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[xmlrpc.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="doDateXML"> + <description> + <![CDATA[]]> +</description> + <argument_list>(data)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[xmlrpc.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="doArrayXML"> + <description> + <![CDATA[]]> +</description> + <argument_list>(data)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[xmlrpc.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="doStructXML"> + <description> + <![CDATA[]]> +</description> + <argument_list>(data)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[xmlrpc.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getParamXML"> + <description> + <![CDATA[]]> +</description> + <argument_list>(type, data)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[xmlrpc.js]]> +</value> + </var> + </vars> + </method> + </instance-methods> + <instance-fields></instance-fields> + <class-methods></class-methods> + <class-fields></class-fields> + <inner-classes></inner-classes> + </class> + <class name="PersistentPageMod"> + <constructor_args>(window, callback)</constructor_args> + <constructor_vars> + <var name="filename"> + <value> + <![CDATA[persistent-page-mod.js]]> +</value> + </var> + <var name="constructor"> + <value> + <![CDATA[]]> +</value> + </var> + </constructor_vars> + <constructor_detail> + <![CDATA[]]> +</constructor_detail> + <instance-methods> + <method mapped_name="doMod"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[persistent-page-mod.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="handleEvent"> + <description> + <![CDATA[]]> +</description> + <argument_list>(event)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[persistent-page-mod.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="unload"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[persistent-page-mod.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + </instance-methods> + <instance-fields> + <field name="window"> + <field-value> + <![CDATA[window]]> +</field-value> + <field-description> + <![CDATA[]]> +</field-description> + <vars></vars> + </field> + <field name="callback"> + <field-value> + <![CDATA[callback]]> +</field-value> + <field-description> + <![CDATA[]]> +</field-description> + <vars></vars> + </field> + <field name="REPLACE_DELAY"> + <field-value> + <![CDATA[100]]> +</field-value> + <field-description> + <![CDATA[]]> +</field-description> + <vars></vars> + </field> + </instance-fields> + <class-methods></class-methods> + <class-fields></class-fields> + <inner-classes></inner-classes> + </class> + <class name="Logger"> + <constructor_args>(store, abbsMap)</constructor_args> + <constructor_vars> + <var name="filename"> + <value> + <![CDATA[logger.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </constructor_vars> + <constructor_detail> + <![CDATA[]]> +</constructor_detail> + <instance-methods> + <method mapped_name="addLogRecord"> + <description> + <![CDATA[]]> +</description> + <argument_list>(that)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[logger.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getLength"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[logger.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getBugzillaAbbr"> + <description> + <![CDATA[]]> +</description> + <argument_list>(url)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[logger.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="timeSheetRecordsPrinter"> + <description> + <![CDATA[]]> +</description> + <argument_list>(body, records)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[logger.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="createBlankPage"> + <description> + <![CDATA[]]> +</description> + <argument_list>(ttl, bodyBuildCB)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[logger.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="generateTimeSheet"> + <description> + <![CDATA[]]> +</description> + <argument_list>(body)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[logger.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + </instance-methods> + <instance-fields></instance-fields> + <class-methods></class-methods> + <class-fields></class-fields> + <inner-classes></inner-classes> + </class> + <class name="Color"> + <constructor_args>(r, g, b)</constructor_args> + <constructor_vars> + <var name="filename"> + <value> + <![CDATA[color.js]]> +</value> + </var> + </constructor_vars> + <constructor_detail> + <![CDATA[]]> +</constructor_detail> + <instance-methods> + <method mapped_name="update"> + <description> + <![CDATA[]]> +</description> + <argument_list>(r, g, b)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[color.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="hs"> + <description> + <![CDATA[]]> +</description> + <argument_list>(nStr)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[color.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="toString"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[color.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="hsl"> + <description> + <![CDATA[Converts an RGB color value to HSL. Conversion formula adapted from http://en.wikipedia.org/wiki/HSL_color_space. Assumes r, g, and b are - contained in the set [0, 255] and returns h, s, and l in the set [0, 1].4343]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[color.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[Number r The red color value ]]></value> - - <value><![CDATA[Number g The green color value ]]></value> - - <value><![CDATA[Number b The blue color value ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[Array The HSL representation]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="hslToRgb"> - <description><![CDATA[Converts an HSL color value to RGB. Conversion formula adapted from + contained in the set [0, 255] and returns h, s, and l in the set [0, 1].4343]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[color.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[Number r The red color value ]]> +</value> + <value> + <![CDATA[Number g The green color value ]]> +</value> + <value> + <![CDATA[Number b The blue color value ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[Array The HSL representation]]> +</value> + </var> + </vars> + </method> + <method mapped_name="hslToRgb"> + <description> + <![CDATA[Converts an HSL color value to RGB. Conversion formula adapted from http://en.wikipedia.org/wiki/HSL_color_space. Assumes h, s, and l are - contained in the set [0, 1] and returns r, g, and b in the set [0, 255].]]></description> - <argument_list>(h, s, l)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[color.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[Number h The hue ]]></value> - - <value><![CDATA[Number s The saturation ]]></value> - - <value><![CDATA[Number l The lightness ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[Array The RGB representation]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="hsv"> - <description><![CDATA[Converts an RGB color value to HSV. Conversion formula adapted from + contained in the set [0, 1] and returns r, g, and b in the set [0, 255].]]> +</description> + <argument_list>(h, s, l)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[color.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[Number h The hue ]]> +</value> + <value> + <![CDATA[Number s The saturation ]]> +</value> + <value> + <![CDATA[Number l The lightness ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[Array The RGB representation]]> +</value> + </var> + </vars> + </method> + <method mapped_name="hsv"> + <description> + <![CDATA[Converts an RGB color value to HSV. Conversion formula adapted from http://en.wikipedia.org/wiki/HSV_color_space. Assumes r, g, and b are - contained in the set [0, 255] and returns h, s, and v in the set [0, 1].]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[color.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[Number r The red color value ]]></value> - - <value><![CDATA[Number g The green color value ]]></value> - - <value><![CDATA[Number b The blue color value ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[Array The HSV representation]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="hsvToRgb"> - <description><![CDATA[Converts an HSV color value to RGB. Conversion formula adapted from + contained in the set [0, 255] and returns h, s, and v in the set [0, 1].]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[color.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[Number r The red color value ]]> +</value> + <value> + <![CDATA[Number g The green color value ]]> +</value> + <value> + <![CDATA[Number b The blue color value ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[Array The HSV representation]]> +</value> + </var> + </vars> + </method> + <method mapped_name="hsvToRgb"> + <description> + <![CDATA[Converts an HSV color value to RGB. Conversion formula adapted from http://en.wikipedia.org/wiki/HSV_color_space. Assumes h, s, and v are - contained in the set [0, 1] and returns r, g, and b in the set [0, 255].]]></description> - <argument_list>(h, s, v)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[color.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[Number h The hue ]]></value> - - <value><![CDATA[Number s The saturation ]]></value> - - <value><![CDATA[Number v The value ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[Array The RGB representation]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="lightColor"> - <description><![CDATA[Provide]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[color.js]]></value> - - </var> - - </vars> - </method> - - </instance-methods> - - <instance-fields> - - <field name="Luminosity"> - <field-value><![CDATA[0.85]]></field-value> - <field-description><![CDATA[]]></field-description> - <vars> - - </vars> - </field> - - <field name="Desaturated"> - <field-value><![CDATA[0.4]]></field-value> - <field-description><![CDATA[]]></field-description> - <vars> - - </vars> - </field> - - <field name="r"> - <field-value><![CDATA[r[0]]]></field-value> - <field-description><![CDATA[]]></field-description> - <vars> - - </vars> - </field> - - <field name="g"> - <field-value><![CDATA[r[1]]]></field-value> - <field-description><![CDATA[]]></field-description> - <vars> - - </vars> - </field> - - <field name="b"> - <field-value><![CDATA[r[2]]]></field-value> - <field-description><![CDATA[]]></field-description> - <vars> - - </vars> - </field> - - </instance-fields> - - <class-methods> - - - - </class-methods> - - <class-fields> - - - </class-fields> - - <inner-classes> - - </inner-classes> - - - </class> - - <class - name="RHBugzillaPage" - > - <constructor_args>(win, config)</constructor_args> - <constructor_vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - </constructor_vars> - - <constructor_detail><![CDATA[]]></constructor_detail> - - <instance-methods> - - <method mapped_name="serializeForm"> - <description><![CDATA[]]></description> - <argument_list>(form)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[offline-support.js]]></value> - - </var> - - <var name="todo"> - - <value><![CDATA[FIXME this probably makes a closure and a memory leak name='changeform' investigate https://developer.mozilla.org/en/How_to_Turn_Off_Form_Autocompletion <form method="post" action="process_bug.cgi" autocomplete="off"> Reading http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#h-17.13 random notes: - 17.13.3 provides all steps necessary - enctype != application/x-www-form-urlencoded => SHOULD fails (no further questions needed) - http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1. is nice explanation (albeit quite dated) - on multiple values http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#h-17.6.1 - pÅ™ÃliÅ¡ jednoduché http://www.innovation.ch/java/HTTPClient/emulating_forms.html -]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="toString"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getDefaultAssignee"> - <description><![CDATA[Find default assignee based on the current component]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[String what would be a default assignee if we haven't set it up.]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="setDefaultAssignee"> - <description><![CDATA[Set default assignee]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[none sets this.defaultAssignee property according to defaultAssignee list]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="closeSomeRelease"> - <description><![CDATA[Auxiliary function to computer more complicated resolution]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="centralCommandDispatch"> - <description><![CDATA[Additional commands specific for this subclass, overriding superclass one.]]></description> - <argument_list>(cmdLabel, cmdParams)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="pasteBacktraceInComments"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="markBadAttachments"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="isEnterprise"> - <description><![CDATA[Is this bug a RHEL bug?]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[Boolean true if it is a RHEL bug]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="isTriaged"> - <description><![CDATA[Find out whether the bug is needed an attention of bugZappers]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[Boolean whether the bug has been triaged or not]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="setBranding"> - <description><![CDATA[Set branding colours to easily distinguish between Fedora and RHEL bugs]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[brand String with product of the current bug ]]></value> - - <value><![CDATA[version String with the version of the bug ]]></value> - - <value><![CDATA[its String with the IsueTracker numbers ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[none]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="fillInWhiteBoard"> - <description><![CDATA[Given line to be parsed, find out which chipset it is and fill in the - whiteboard]]></description> - <argument_list>(iLine, driverStr)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[iLine String with the whole unparsed "interesting line" ]]></value> - - <value><![CDATA[driverStr String with the driver name ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[None]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="fillInChipMagic"> - <description><![CDATA[Get attached Xorg.0.log, parse it and find the value of chip. Does not fill + contained in the set [0, 1] and returns r, g, and b in the set [0, 255].]]> +</description> + <argument_list>(h, s, v)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[color.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[Number h The hue ]]> +</value> + <value> + <![CDATA[Number s The saturation ]]> +</value> + <value> + <![CDATA[Number v The value ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[Array The RGB representation]]> +</value> + </var> + </vars> + </method> + <method mapped_name="lightColor"> + <description> + <![CDATA[Provide]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[color.js]]> +</value> + </var> + </vars> + </method> + </instance-methods> + <instance-fields> + <field name="Luminosity"> + <field-value> + <![CDATA[0.85]]> +</field-value> + <field-description> + <![CDATA[]]> +</field-description> + <vars></vars> + </field> + <field name="Desaturated"> + <field-value> + <![CDATA[0.4]]> +</field-value> + <field-description> + <![CDATA[]]> +</field-description> + <vars></vars> + </field> + <field name="r"> + <field-value> + <![CDATA[r[0]]]> +</field-value> + <field-description> + <![CDATA[]]> +</field-description> + <vars></vars> + </field> + <field name="g"> + <field-value> + <![CDATA[r[1]]]> +</field-value> + <field-description> + <![CDATA[]]> +</field-description> + <vars></vars> + </field> + <field name="b"> + <field-value> + <![CDATA[r[2]]]> +</field-value> + <field-description> + <![CDATA[]]> +</field-description> + <vars></vars> + </field> + </instance-fields> + <class-methods></class-methods> + <class-fields></class-fields> + <inner-classes></inner-classes> + </class> + <class name="RHBugzillaPage"> + <constructor_args>(win, config)</constructor_args> + <constructor_vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + </constructor_vars> + <constructor_detail> + <![CDATA[]]> +</constructor_detail> + <instance-methods> + <method mapped_name="serializeForm"> + <description> + <![CDATA[]]> +</description> + <argument_list>(form)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[offline-support.js]]> +</value> + </var> + <var name="todo"> + <value> + <![CDATA[FIXME this probably makes a closure and a memory leak name='changeform' investigate https://developer.mozilla.org/en/How_to_Turn_Off_Form_Autocompletion <form method="post" action="process_bug.cgi" autocomplete="off"> Reading http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#h-17.13 random notes: - 17.13.3 provides all steps necessary - enctype != application/x-www-form-urlencoded => SHOULD fails (no further questions needed) - http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2.1. is nice explanation (albeit quite dated) - on multiple values http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#h-17.6.1 - pÅ™ÃliÅ¡ jednoduché http://www.innovation.ch/java/HTTPClient/emulating_forms.html -]]> +</value> + </var> + </vars> + </method> + <method mapped_name="toString"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getDefaultAssignee"> + <description> + <![CDATA[Find default assignee based on the current component]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[String what would be a default assignee if we haven't set it up.]]> +</value> + </var> + </vars> + </method> + <method mapped_name="setDefaultAssignee"> + <description> + <![CDATA[Set default assignee]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[none sets this.defaultAssignee property according to defaultAssignee list]]> +</value> + </var> + </vars> + </method> + <method mapped_name="closeSomeRelease"> + <description> + <![CDATA[Auxiliary function to computer more complicated resolution]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="centralCommandDispatch"> + <description> + <![CDATA[Additional commands specific for this subclass, overriding superclass one.]]> +</description> + <argument_list>(cmdLabel, cmdParams)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="pasteBacktraceInComments"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="markBadAttachments"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="isEnterprise"> + <description> + <![CDATA[Is this bug a RHEL bug?]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[Boolean true if it is a RHEL bug]]> +</value> + </var> + </vars> + </method> + <method mapped_name="isTriaged"> + <description> + <![CDATA[Find out whether the bug is needed an attention of bugZappers]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[Boolean whether the bug has been triaged or not]]> +</value> + </var> + </vars> + </method> + <method mapped_name="setBranding"> + <description> + <![CDATA[Set branding colours to easily distinguish between Fedora and RHEL bugs]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[brand String with product of the current bug ]]> +</value> + <value> + <![CDATA[version String with the version of the bug ]]> +</value> + <value> + <![CDATA[its String with the IsueTracker numbers ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[none]]> +</value> + </var> + </vars> + </method> + <method mapped_name="fillInWhiteBoard"> + <description> + <![CDATA[Given line to be parsed, find out which chipset it is and fill in the + whiteboard]]> +</description> + <argument_list>(iLine, driverStr)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[iLine String with the whole unparsed "interesting line" ]]> +</value> + <value> + <![CDATA[driverStr String with the driver name ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[None]]> +</value> + </var> + </vars> + </method> + <method mapped_name="fillInChipMagic"> + <description> + <![CDATA[Get attached Xorg.0.log, parse it and find the value of chip. Does not fill the whiteboard itself, just adds button to do so,paramList so that slow - XMLHttpRequest is done in advance.]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[None]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getSelectionOrClipboard"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="queryInNewTab"> - <description><![CDATA[Opens a new tab with a query for the given text in the selected component]]></description> - <argument_list>(text, component, product)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[text to be searched for ]]></value> - - <value><![CDATA[component String with the component name (maybe latter regexp?) ]]></value> - - <value><![CDATA[product (optional) string with the product name, if undefined, search in all products ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[None]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="queryForSelection"> - <description><![CDATA[Get the text to search for and prepare other things for the real executive - function this.queryInNewTab, and run it.]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="queryUpstream"> - <description><![CDATA[Search simple query in the upstream bugzilla appropriate for the component.]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="sendBugUpstream"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="parseAttachmentLine"> - <description><![CDATA[Parse the row with the attachment]]></description> - <argument_list>(inElem)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[DOM element to be parsed ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[array with string name of the attachment, integer its id number, string of MIME type, integer of size in kilobytes, and the whole element itself]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="fixElement"> - <description><![CDATA[Add accesskey to the particular element]]></description> - <argument_list>(elem, beforeText, accKey, afterText)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[rootElement Element to which the new text object will be attached ]]></value> - - <value><![CDATA[beforeText Text before the accesskey character ]]></value> - - <value><![CDATA[accKey what will be the accesskey itself ]]></value> - - <value><![CDATA[afterText text after the accesskey character ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[modified element with the fixed accesskey]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getBugzillaName"> - <description><![CDATA[Return string with the ID for the external_id SELECT for external bugzilla]]></description> - <argument_list>(URLhostname)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[URLhostname String hostname of the external bugzilla ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[String with the string for the external_id SELECT]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="fixingMIMECallBack"> - <description><![CDATA[Callback function for the XMLRPC request]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[ret Object with xmlhttprequest response with attributes: + status -- int return code + statusText + responseHeaders + responseText ]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="fixAttachById"> - <description><![CDATA[The worker function -- call XMLRPC to fix MIME type of the particular - attachment]]></description> - <argument_list>(id, type, email)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[id Integer with the attachment id to be fixed ]]></value> - - <value><![CDATA[type String with the new MIME type, optional defaults to "text/plain" ]]></value> - - <value><![CDATA[email Boolean whether email should be sent to appropriate person; option, defaults to false updateAttachMimeType($data_ref, $username, $password) Update the attachment mime type of an attachment. The first argument is a data hash containing information on the new MIME type and the attachment id that you want to act on. $data_ref = { "attach_id" => "<Attachment ID>", # Attachment ID to perform MIME type change on. "mime_type" => "<New MIME Type Value>", # Legal MIME type value that you want to change the attachment to. "nomail" => 0, # OPTIONAL Flag that is either 1 or 0 if you want email to be sent or not for this change }; ]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="createFixAllButton"> - <description><![CDATA[Create a button for fixing all bad attachments.]]></description> - <argument_list>(list)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[list Array of all bad attachmentss ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[button fixing all bad Attachments]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="addTextLink"> - <description><![CDATA[Add a link to the bad attachment for fixing it.]]></description> - <argument_list>(row)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[<TR> DOM jQuery element with a bad attachment ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[none]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="addClosingUpstream"> - <description><![CDATA[Add information about the upstream bug upstream, and closing it.]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[evt Event which called this handler ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[none]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="markBugTriaged"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="parseBacktrace"> - <description><![CDATA[]]></description> - <argument_list>(ret)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[rhbzpage.js]]></value> - - </var> - - </vars> - </method> - - </instance-methods> - - <instance-fields> - - <field name="ProfessionalProducts"> - <field-value><![CDATA[[]]></field-value> - <field-description><![CDATA[]]></field-description> - <vars> - - </vars> - </field> - - </instance-fields> - - <class-methods> - - - - </class-methods> - - <class-fields> - - - </class-fields> - - <inner-classes> - - </inner-classes> - - - </class> - - <class - name="BZPage" - > - <constructor_args>(win, config)</constructor_args> - <constructor_vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - </constructor_vars> - - <constructor_detail><![CDATA[]]></constructor_detail> - - <instance-methods> - - <method mapped_name="getBugId"> - <description><![CDATA[Get the ID of the bug.]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[string]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getInstalledPackages"> - <description><![CDATA[]]></description> - <argument_list>(cfg)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="centralCommandDispatch"> - <description><![CDATA[Actual execution function]]></description> - <argument_list>(cmdLabel, cmdParams)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[cmdLabel String with the name of the command to be executed ]]></value> - - <value><![CDATA[cmdParams Object with the appropriate parameters for the command ]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="executeCommand"> - <description><![CDATA[Take the ID of the package/id combination, and execute it]]></description> - <argument_list>(cmd)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[String combined package + "//" + id combination Fetches the command object from this.installedPackages and then goes through all commands contained in it, and calls this.centralCommandDispatch to execute them. ]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="changeAssignee"> - <description><![CDATA[Add XGL to the CC list]]></description> - <argument_list>(newAssignee)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[evt Event which made this function active ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[none]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="addToCommentsDropdown"> - <description><![CDATA[Adds new option to the 'comment_action' scroll down box]]></description> - <argument_list>(pkg, cmd)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[pkg String package name ]]></value> - - <value><![CDATA[cmd String with the name of the command If the 'comment_action' scroll down box doesn't exist, this function will set up new one. ]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="createNewButton"> - <description><![CDATA[Generic function to add new button to the page. Actually copies new button - from the old one (in order to have the same look-and-feel, etc.]]></description> - <argument_list>(location, after, pkg, id)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[location Object around which the new button will be added ]]></value> - - <value><![CDATA[after Boolean before or after location ? ]]></value> - - <value><![CDATA[pkg String which package to take the command from ]]></value> - - <value><![CDATA[id String which command to take ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[none]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="generateButtons"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getReporter"> - <description><![CDATA[Get the current email of the reporter of the bug.]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[string]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getVersion"> - <description><![CDATA[Get the current version of the Fedora release ... even if changed meanwhile - by bug triager.]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[string (integer for released Fedora, float for RHEL, rawhide)]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="commentsWalker"> - <description><![CDATA[]]></description> - <argument_list>(fce)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="checkComments"> - <description><![CDATA[Set background color of all comments made by reporter in ReporterColor color]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="collectComments"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="selectOption"> - <description><![CDATA[Select option with given label on the <SELECT> element with given id. - - Also execute change HTMLEvent, so that the form behaves accordingly.]]></description> - <argument_list>(id, label)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[id ]]></value> - - <value><![CDATA[label ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[none FIXME bugzilla-comments version has this signature: selectOption = function selectOption(select, value) { var doc = select[0].ownerDocument; select.val(value);]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="clickMouse"> - <description><![CDATA[Send mouse click to the specified element]]></description> - <argument_list>(targetID)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[String ID of the element to send mouseclick to ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[None]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="addStuffToTextBox"> - <description><![CDATA[Add object to the text box (comment box or status whiteboard)]]></description> - <argument_list>(id, stuff)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[id String with the id of the element ]]></value> - - <value><![CDATA[stuff String/Array to be added to the comment box ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[none]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="removeStuffFromTextBox"> - <description><![CDATA[Remove a keyword from the element if it is there]]></description> - <argument_list>(id, stuff)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[id String with the id of the element ]]></value> - - <value><![CDATA[stuff String/Array with keyword(s) to be removed ]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="idContainsWord"> - <description><![CDATA[generalized hasKeyword ... search in the value of the box with given id]]></description> - <argument_list>(id, str)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[id String with ID of the element we want to check ]]></value> - - <value><![CDATA[str String to be searched for ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[Boolean found?]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="hasKeyword"> - <description><![CDATA[Check for the presence of a keyword]]></description> - <argument_list>(str)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[str String with the keyword ]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[Boolean]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getOptionValue"> - <description><![CDATA[]]></description> - <argument_list>(id)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="setNeedinfoReporter"> - <description><![CDATA[Set the bug to NEEDINFO state - - Working function.]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="todo"> - - <value><![CDATA[TODO we may extend this to general setNeedinfo function with parameter [reporter|assignee|general-email-address]]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[none ]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getOwner"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getLogin"> - <description><![CDATA[Get login of the currently logged-in user.]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[String with the login name of the currently logged-in user]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getDefaultBugzillaMaintainer"> - <description><![CDATA[Return maintainer which is per default by bugzilla - (which is not necessarily the one who is default maintainer per component)]]></description> - <argument_list>(component)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[String with the maintainer's email address]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getAttachments"> - <description><![CDATA[collect the list of attachments in a structured format]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[Array of arrays, one for each attachments; each record has string name of the attachment, integer its id number, string of MIME type, integer of size in kilobytes, and the whole element itself]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getPassword"> - <description><![CDATA[returns password from the current storage, or if there isn't - one, then it will ask user for it.]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[String with the password]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="setUpLogging"> - <description><![CDATA[]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="addToCCList"> - <description><![CDATA[adds a person to the CC list, if it isn't already there]]></description> - <argument_list>(who)</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="type"> - - <value><![CDATA[void]]></value> - - </var> - - <var name="param"> - - <value><![CDATA[who String with email address or "self" if the current user of the bugzilla should be added ]]></value> - - </var> - - </vars> - </method> - - <method mapped_name="getCCList"> - <description><![CDATA[a collect a list of emails on CC list]]></description> - <argument_list>()</argument_list> - <vars> - - <var name="filename"> - - <value><![CDATA[bzpage.js]]></value> - - </var> - - <var name="return"> - - <value><![CDATA[Array with email addresses as Strings.]]></value> - - </var> - - </vars> - </method> - - </instance-methods> - - <instance-fields> - - </instance-fields> - - <class-methods> - - - - </class-methods> - - <class-fields> - - - </class-fields> - - <inner-classes> - - </inner-classes> - - - </class> - - <class - name="MozillaBugzilla" - > - <constructor_args>(doc, config)</constructor_args> - <constructor_vars> - - <var name="filename"> - - <value><![CDATA[mozillabzpage.js]]></value> - - </var> - - </constructor_vars> - - <constructor_detail><![CDATA[]]></constructor_detail> - - <instance-methods> - - </instance-methods> - - <instance-fields> - - </instance-fields> - - <class-methods> - - - - </class-methods> - - <class-fields> - - - </class-fields> - - <inner-classes> - - </inner-classes> - - - </class> - - </classes> + XMLHttpRequest is done in advance.]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[None]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getSelectionOrClipboard"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="queryInNewTab"> + <description> + <![CDATA[Opens a new tab with a query for the given text in the selected component]]> +</description> + <argument_list>(text, component, product)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[text to be searched for ]]> +</value> + <value> + <![CDATA[component String with the component name (maybe latter regexp?) ]]> +</value> + <value> + <![CDATA[product (optional) string with the product name, if undefined, search in all products ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[None]]> +</value> + </var> + </vars> + </method> + <method mapped_name="queryForSelection"> + <description> + <![CDATA[Get the text to search for and prepare other things for the real executive + function this.queryInNewTab, and run it.]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="queryUpstream"> + <description> + <![CDATA[Search simple query in the upstream bugzilla appropriate for the component.]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="sendBugUpstream"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="parseAttachmentLine"> + <description> + <![CDATA[Parse the row with the attachment]]> +</description> + <argument_list>(inElem)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[DOM element to be parsed ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[array with string name of the attachment, integer its id number, string of MIME type, integer of size in kilobytes, and the whole element itself]]> +</value> + </var> + </vars> + </method> + <method mapped_name="fixElement"> + <description> + <![CDATA[Add accesskey to the particular element]]> +</description> + <argument_list>(elem, beforeText, accKey, + afterText)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[rootElement Element to which the new text object will be attached ]]> +</value> + <value> + <![CDATA[beforeText Text before the accesskey character ]]> +</value> + <value> + <![CDATA[accKey what will be the accesskey itself ]]> +</value> + <value> + <![CDATA[afterText text after the accesskey character ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[modified element with the fixed accesskey]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getBugzillaName"> + <description> + <![CDATA[Return string with the ID for the external_id SELECT for external bugzilla]]> +</description> + <argument_list>(URLhostname)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[URLhostname String hostname of the external bugzilla ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[String with the string for the external_id SELECT]]> +</value> + </var> + </vars> + </method> + <method mapped_name="fixingMIMECallBack"> + <description> + <![CDATA[Callback function for the XMLRPC request]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[ret Object with xmlhttprequest response with attributes: + status -- int return code + statusText + responseHeaders + responseText ]]> +</value> + </var> + </vars> + </method> + <method mapped_name="fixAttachById"> + <description> + <![CDATA[The worker function -- call XMLRPC to fix MIME type of the particular + attachment]]> +</description> + <argument_list>(id, type, email)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[id Integer with the attachment id to be fixed ]]> +</value> + <value> + <![CDATA[type String with the new MIME type, optional defaults to "text/plain" ]]> +</value> + <value> + <![CDATA[email Boolean whether email should be sent to appropriate person; option, defaults to false updateAttachMimeType($data_ref, $username, $password) Update the attachment mime type of an attachment. The first argument is a data hash containing information on the new MIME type and the attachment id that you want to act on. $data_ref = { "attach_id" => "<Attachment ID>", # Attachment ID to perform MIME type change on. "mime_type" => "<New MIME Type Value>", # Legal MIME type value that you want to change the attachment to. "nomail" => 0, # OPTIONAL Flag that is either 1 or 0 if you want email to be sent or not for this change }; ]]> +</value> + </var> + </vars> + </method> + <method mapped_name="createFixAllButton"> + <description> + <![CDATA[Create a button for fixing all bad attachments.]]> +</description> + <argument_list>(list)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[list Array of all bad attachmentss ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[button fixing all bad Attachments]]> +</value> + </var> + </vars> + </method> + <method mapped_name="addTextLink"> + <description> + <![CDATA[Add a link to the bad attachment for fixing it.]]> +</description> + <argument_list>(row)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[<TR> DOM jQuery element with a bad attachment ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[none]]> +</value> + </var> + </vars> + </method> + <method mapped_name="addClosingUpstream"> + <description> + <![CDATA[Add information about the upstream bug upstream, and closing it.]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[evt Event which called this handler ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[none]]> +</value> + </var> + </vars> + </method> + <method mapped_name="markBugTriaged"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="parseBacktrace"> + <description> + <![CDATA[]]> +</description> + <argument_list>(ret)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[rhbzpage.js]]> +</value> + </var> + </vars> + </method> + </instance-methods> + <instance-fields> + <field name="ProfessionalProducts"> + <field-value> + <![CDATA[[]]> +</field-value> + <field-description> + <![CDATA[]]> +</field-description> + <vars></vars> + </field> + </instance-fields> + <class-methods></class-methods> + <class-fields></class-fields> + <inner-classes></inner-classes> + </class> + <class name="BZPage"> + <constructor_args>(win, config)</constructor_args> + <constructor_vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + </constructor_vars> + <constructor_detail> + <![CDATA[]]> +</constructor_detail> + <instance-methods> + <method mapped_name="getBugId"> + <description> + <![CDATA[Get the ID of the bug.]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[string]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getInstalledPackages"> + <description> + <![CDATA[]]> +</description> + <argument_list>(cfg)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="centralCommandDispatch"> + <description> + <![CDATA[Actual execution function]]> +</description> + <argument_list>(cmdLabel, cmdParams)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[cmdLabel String with the name of the command to be executed ]]> +</value> + <value> + <![CDATA[cmdParams Object with the appropriate parameters for the command ]]> +</value> + </var> + </vars> + </method> + <method mapped_name="executeCommand"> + <description> + <![CDATA[Take the ID of the package/id combination, and execute it]]> +</description> + <argument_list>(cmd)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[String combined package + "//" + id combination Fetches the command object from this.installedPackages and then goes through all commands contained in it, and calls this.centralCommandDispatch to execute them. ]]> +</value> + </var> + </vars> + </method> + <method mapped_name="changeAssignee"> + <description> + <![CDATA[Add XGL to the CC list]]> +</description> + <argument_list>(newAssignee)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[evt Event which made this function active ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[none]]> +</value> + </var> + </vars> + </method> + <method mapped_name="addToCommentsDropdown"> + <description> + <![CDATA[Adds new option to the 'comment_action' scroll down box]]> +</description> + <argument_list>(pkg, cmd)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[pkg String package name ]]> +</value> + <value> + <![CDATA[cmd String with the name of the command If the 'comment_action' scroll down box doesn't exist, this function will set up new one. ]]> +</value> + </var> + </vars> + </method> + <method mapped_name="createNewButton"> + <description> + <![CDATA[Generic function to add new button to the page. Actually copies new button + from the old one (in order to have the same look-and-feel, etc.]]> +</description> + <argument_list>(location, after, pkg, id)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[location Object around which the new button will be added ]]> +</value> + <value> + <![CDATA[after Boolean before or after location ? ]]> +</value> + <value> + <![CDATA[pkg String which package to take the command from ]]> +</value> + <value> + <![CDATA[id String which command to take ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[none]]> +</value> + </var> + </vars> + </method> + <method mapped_name="generateButtons"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getReporter"> + <description> + <![CDATA[Get the current email of the reporter of the bug.]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[string]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getVersion"> + <description> + <![CDATA[Get the current version of the Fedora release ... even if changed meanwhile + by bug triager.]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[string (integer for released Fedora, float for RHEL, rawhide)]]> +</value> + </var> + </vars> + </method> + <method mapped_name="commentsWalker"> + <description> + <![CDATA[]]> +</description> + <argument_list>(fce)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="checkComments"> + <description> + <![CDATA[Set background color of all comments made by reporter in ReporterColor color]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="collectComments"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="selectOption"> + <description> + <![CDATA[Select option with given label on the <SELECT> element with given id. + Also execute change HTMLEvent, so that the form behaves accordingly.]]> +</description> + <argument_list>(id, label)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[id ]]> +</value> + <value> + <![CDATA[label ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[none FIXME bugzilla-comments version has this signature: selectOption = function selectOption(select, value) { var doc = select[0].ownerDocument; select.val(value);]]> +</value> + </var> + </vars> + </method> + <method mapped_name="clickMouse"> + <description> + <![CDATA[Send mouse click to the specified element]]> +</description> + <argument_list>(targetID)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[String ID of the element to send mouseclick to ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[None]]> +</value> + </var> + </vars> + </method> + <method mapped_name="addStuffToTextBox"> + <description> + <![CDATA[Add object to the text box (comment box or status whiteboard)]]> +</description> + <argument_list>(id, stuff)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[id String with the id of the element ]]> +</value> + <value> + <![CDATA[stuff String/Array to be added to the comment box ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[none]]> +</value> + </var> + </vars> + </method> + <method mapped_name="removeStuffFromTextBox"> + <description> + <![CDATA[Remove a keyword from the element if it is there]]> +</description> + <argument_list>(id, stuff)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[id String with the id of the element ]]> +</value> + <value> + <![CDATA[stuff String/Array with keyword(s) to be removed ]]> +</value> + </var> + </vars> + </method> + <method mapped_name="idContainsWord"> + <description> + <![CDATA[generalized hasKeyword ... search in the value of the box with given id]]> +</description> + <argument_list>(id, str)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[id String with ID of the element we want to check ]]> +</value> + <value> + <![CDATA[str String to be searched for ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[Boolean found?]]> +</value> + </var> + </vars> + </method> + <method mapped_name="hasKeyword"> + <description> + <![CDATA[Check for the presence of a keyword]]> +</description> + <argument_list>(str)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[str String with the keyword ]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[Boolean]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getOptionValue"> + <description> + <![CDATA[]]> +</description> + <argument_list>(id)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="setNeedinfoReporter"> + <description> + <![CDATA[Set the bug to NEEDINFO state + Working function.]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="todo"> + <value> + <![CDATA[TODO we may extend this to general setNeedinfo function with parameter [reporter|assignee|general-email-address]]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[none ]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getOwner"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getLogin"> + <description> + <![CDATA[Get login of the currently logged-in user.]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[String with the login name of the currently logged-in user]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getDefaultBugzillaMaintainer"> + <description> + <![CDATA[Return maintainer which is per default by bugzilla + (which is not necessarily the one who is default maintainer per component)]]> +</description> + <argument_list>(component)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[String with the maintainer's email address]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getAttachments"> + <description> + <![CDATA[collect the list of attachments in a structured format]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[Array of arrays, one for each attachments; each record has string name of the attachment, integer its id number, string of MIME type, integer of size in kilobytes, and the whole element itself]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getPassword"> + <description> + <![CDATA[returns password from the current storage, or if there isn't + one, then it will ask user for it.]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[String with the password]]> +</value> + </var> + </vars> + </method> + <method mapped_name="setUpLogging"> + <description> + <![CDATA[]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + </vars> + </method> + <method mapped_name="addToCCList"> + <description> + <![CDATA[adds a person to the CC list, if it isn't already there]]> +</description> + <argument_list>(who)</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="type"> + <value> + <![CDATA[void]]> +</value> + </var> + <var name="param"> + <value> + <![CDATA[who String with email address or "self" if the current user of the bugzilla should be added ]]> +</value> + </var> + </vars> + </method> + <method mapped_name="getCCList"> + <description> + <![CDATA[a collect a list of emails on CC list]]> +</description> + <argument_list>()</argument_list> + <vars> + <var name="filename"> + <value> + <![CDATA[bzpage.js]]> +</value> + </var> + <var name="return"> + <value> + <![CDATA[Array with email addresses as Strings.]]> +</value> + </var> + </vars> + </method> + </instance-methods> + <instance-fields></instance-fields> + <class-methods></class-methods> + <class-fields></class-fields> + <inner-classes></inner-classes> + </class> + <class name="MozillaBugzilla"> + <constructor_args>(doc, config)</constructor_args> + <constructor_vars> + <var name="filename"> + <value> + <![CDATA[mozillabzpage.js]]> +</value> + </var> + </constructor_vars> + <constructor_detail> + <![CDATA[]]> +</constructor_detail> + <instance-methods></instance-methods> + <instance-fields></instance-fields> + <class-methods></class-methods> + <class-fields></class-fields> + <inner-classes></inner-classes> + </class> + </classes> </javascript> |