From 47f8de7261fa8077a63058d5185e3cbb74983ff7 Mon Sep 17 00:00:00 2001 From: Matěj Cepl Date: Wed, 23 Jun 2010 15:12:16 +0200 Subject: Raw HTML documentation generated by JSDoc from Javadoc comments in the code --- docs/html/BZPage.html | 1521 +++++++++++++ docs/html/Color.html | 746 +++++++ docs/html/GLOBALS.html | 406 ++++ docs/html/Logger.html | 471 ++++ docs/html/MozillaBugzilla.html | 250 +++ docs/html/PersistentPageMod.html | 445 ++++ docs/html/RHBugzillaPage.html | 1500 +++++++++++++ docs/html/XMLRPCMessage.html | 562 +++++ docs/html/allclasses-frame.html | 77 + docs/html/allclasses-noframe.html | 78 + docs/html/help-doc.html | 160 ++ docs/html/index-all.html | 898 ++++++++ docs/html/index.html | 27 + docs/html/overview-bzpage.js.html | 36 + docs/html/overview-clipboard.js.html | 30 + docs/html/overview-color.js.html | 36 + docs/html/overview-frame.html | 63 + docs/html/overview-logger.js.html | 36 + docs/html/overview-main.js.html | 30 + docs/html/overview-mozillabzpage.js.html | 36 + docs/html/overview-offline-support.js.html | 30 + docs/html/overview-persistent-page-mod.js.html | 36 + docs/html/overview-rhbzpage.js.html | 36 + docs/html/overview-summary-bzpage.js.html | 915 ++++++++ docs/html/overview-summary-clipboard.js.html | 327 +++ docs/html/overview-summary-color.js.html | 407 ++++ docs/html/overview-summary-logger.js.html | 301 +++ docs/html/overview-summary-main.js.html | 366 ++++ docs/html/overview-summary-mozillabzpage.js.html | 188 ++ docs/html/overview-summary-offline-support.js.html | 307 +++ .../overview-summary-persistent-page-mod.js.html | 228 ++ docs/html/overview-summary-rhbzpage.js.html | 1092 ++++++++++ docs/html/overview-summary-util.js.html | 453 ++++ docs/html/overview-summary-xmlrpc.js.html | 322 +++ docs/html/overview-summary.html | 216 ++ docs/html/overview-tree.html | 128 ++ docs/html/overview-util.js.html | 30 + docs/html/overview-xmlrpc.js.html | 30 + docs/html/stylesheet.css | 39 + docs/jsdoc.xml | 2304 ++++++++++++++++++++ 40 files changed, 15163 insertions(+) create mode 100644 docs/html/BZPage.html create mode 100644 docs/html/Color.html create mode 100644 docs/html/GLOBALS.html create mode 100644 docs/html/Logger.html create mode 100644 docs/html/MozillaBugzilla.html create mode 100644 docs/html/PersistentPageMod.html create mode 100644 docs/html/RHBugzillaPage.html create mode 100644 docs/html/XMLRPCMessage.html create mode 100644 docs/html/allclasses-frame.html create mode 100644 docs/html/allclasses-noframe.html create mode 100644 docs/html/help-doc.html create mode 100644 docs/html/index-all.html create mode 100644 docs/html/index.html create mode 100644 docs/html/overview-bzpage.js.html create mode 100644 docs/html/overview-clipboard.js.html create mode 100644 docs/html/overview-color.js.html create mode 100644 docs/html/overview-frame.html create mode 100644 docs/html/overview-logger.js.html create mode 100644 docs/html/overview-main.js.html create mode 100644 docs/html/overview-mozillabzpage.js.html create mode 100644 docs/html/overview-offline-support.js.html create mode 100644 docs/html/overview-persistent-page-mod.js.html create mode 100644 docs/html/overview-rhbzpage.js.html create mode 100644 docs/html/overview-summary-bzpage.js.html create mode 100644 docs/html/overview-summary-clipboard.js.html create mode 100644 docs/html/overview-summary-color.js.html create mode 100644 docs/html/overview-summary-logger.js.html create mode 100644 docs/html/overview-summary-main.js.html create mode 100644 docs/html/overview-summary-mozillabzpage.js.html create mode 100644 docs/html/overview-summary-offline-support.js.html create mode 100644 docs/html/overview-summary-persistent-page-mod.js.html create mode 100644 docs/html/overview-summary-rhbzpage.js.html create mode 100644 docs/html/overview-summary-util.js.html create mode 100644 docs/html/overview-summary-xmlrpc.js.html create mode 100644 docs/html/overview-summary.html create mode 100644 docs/html/overview-tree.html create mode 100644 docs/html/overview-util.js.html create mode 100644 docs/html/overview-xmlrpc.js.html create mode 100644 docs/html/stylesheet.css create mode 100644 docs/jsdoc.xml (limited to 'docs') diff --git a/docs/html/BZPage.html b/docs/html/BZPage.html new file mode 100644 index 0000000..cc2086c --- /dev/null +++ b/docs/html/BZPage.html @@ -0,0 +1,1521 @@ + + + + + +BZPage + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  File  Class  Tree  Index  Help 
+		 + + +
+ PREV CLASS + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ +
+ + +

Class BZPage

+
Object
+   |
+   +--BZPage
+
+ + +
+
+ +
class + BZPage + + +
+ +

+ Defined in bzpage.js

+

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
+ + + BZPage(win, config) + +
+             + +
+ + + +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ +  Object + + + + + addStuffToTextBox(id, stuff) + +
+            + Add object to the text box (comment box or status whiteboard) +
+ +  void + + + + + addToCCList(who) + +
+            + adds a person to the CC list, if it isn't already there +
+ +  void + + + + + addToCommentsDropdown(pkg, cmd) + +
+            + Adds new option to the 'comment_action' scroll down box +
+ +  void + + + + + centralCommandDispatch(cmdLabel, cmdParams) + +
+            + Actual execution function +
+ +  Object + + + + + changeAssignee(newAssignee) + +
+            + Add XGL to the CC list +
+ +  void + + + + + checkComments() + +
+            + Set background color of all comments made by reporter in ReporterColor color +
+ +  Object + + + + + clickMouse(targetID) + +
+            + Send mouse click to the specified element +
+ +  Object + + + + + collectComments() + +
+            + +
+ +  void + + + + + commentsWalker(fce) + +
+            + +
+ +  Object + + + + + createNewButton(location, after, pkg, id) + +
+            + Generic function to add new button to the page. +
+ +  void + + + + + executeCommand(cmd) + +
+            + Take the ID of the package/id combination, and execute it +
+ +  void + + + + + generateButtons() + +
+            + +
+ +  Object + + + + + getAttachments() + +
+            + collect the list of attachments in a structured format +
+ +  Object + + + + + getBugId() + +
+            + Get the ID of the bug. +
+ +  Object + + + + + getCCList() + +
+            + a collect a list of emails on CC list +
+ +  Object + + + + + getDefaultBugzillaMaintainer(component) + +
+            + Return maintainer which is per default by bugzilla + (which is not necessarily the one who is default maintainer per component) +
+ +  Object + + + + + getInstalledPackages(cfg) + +
+            + +
+ +  Object + + + + + getLogin() + +
+            + Get login of the currently logged-in user. +
+ +  Object + + + + + getOptionValue(id) + +
+            + +
+ +  Object + + + + + getOwner() + +
+            + +
+ +  Object + + + + + getPassword() + +
+            + returns password from the current storage, or if there isn't + one, then it will ask user for it. +
+ +  Object + + + + + getReporter() + +
+            + Get the current email of the reporter of the bug. +
+ +  Object + + + + + getVersion() + +
+            + Get the current version of the Fedora release ... +
+ +  Object + + + + + hasKeyword(str) + +
+            + Check for the presence of a keyword +
+ +  Object + + + + + idContainsWord(id, str) + +
+            + generalized hasKeyword ... +
+ +  void + + + + + removeStuffFromTextBox(id, stuff) + +
+            + Remove a keyword from the element if it is there +
+ +  Object + + + + + selectOption(id, label) + +
+            + Select option with given label on the
+ +  Object + + + + + setNeedinfoReporter() + +
+            + Set the bug to NEEDINFO state + + +
+ +  void + + + + + setUpLogging() + +
+            + +
+ + + +

+ + + + + + + + + + + + + + + +
+ Constructor Detail +
+ +

+BZPage

+
BZPage(win, config)
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + +
+ Method Detail +
+ + + + +

addStuffToTextBox

+ 
Object addStuffToTextBox(id, stuff)
+ + + + + + + + + + + + + + + + + +
+ + +

addToCCList

+ 
void addToCCList(who)
+ + + + + + + + + + + + + + + +
+ + +

addToCommentsDropdown

+ 
void addToCommentsDropdown(pkg, cmd)
+ + + + + + + + + + + + + + + +
+ + +

centralCommandDispatch

+ 
void centralCommandDispatch(cmdLabel, cmdParams)
+ + + + + + + + + + + + + + + +
+ + +

changeAssignee

+ 
Object changeAssignee(newAssignee)
+ + + + + + + + + + + + + + + + + +
+ + +

checkComments

+ 
void checkComments()
+ + + + + + + + + + + + + +
+ + +

clickMouse

+ 
Object clickMouse(targetID)
+ + + + + + + + + + + + + + + + + +
+ + +

collectComments

+ 
Object collectComments()
+ + + + + + + + + + + +
+ + +

commentsWalker

+ 
void commentsWalker(fce)
+ + + + + + + + + + + +
+ + +

createNewButton

+ 
Object createNewButton(location, after, pkg, id)
+ + + + + + + + + + + + + + + + + +
+ + +

executeCommand

+ 
void executeCommand(cmd)
+ + + + + + + + + + + + + + + +
+ + +

generateButtons

+ 
void generateButtons()
+ + + + + + + + + + + +
+ + +

getAttachments

+ 
Object getAttachments()
+ + + + + + + + + + + + + + + +
+ + +

getBugId

+ 
Object getBugId()
+ + + + + + + + + + + + + + + +
+ + +

getCCList

+ 
Object getCCList()
+ + + + + + + + + + + + + + + +
+ + +

getDefaultBugzillaMaintainer

+ 
Object getDefaultBugzillaMaintainer(component)
+ + + + + + + + + + + + + + + +
+ + +

getInstalledPackages

+ 
Object getInstalledPackages(cfg)
+ + + + + + + + + + + +
+ + +

getLogin

+ 
Object getLogin()
+ + + + + + + + + + + + + + + +
+ + +

getOptionValue

+ 
Object getOptionValue(id)
+ + + + + + + + + + + +
+ + +

getOwner

+ 
Object getOwner()
+ + + + + + + + + + + +
+ + +

getPassword

+ 
Object getPassword()
+ + + + + + + + + + + + + + + +
+ + +

getReporter

+ 
Object getReporter()
+ + + + + + + + + + + + + + + +
+ + +

getVersion

+ 
Object getVersion()
+ + + + + + + + + + + + + + + +
+ + +

hasKeyword

+ 
Object hasKeyword(str)
+ + + + + + + + + + + + + + + + + +
+ + +

idContainsWord

+ 
Object idContainsWord(id, str)
+ + + + + + + + + + + + + + + + + +
+ + +

removeStuffFromTextBox

+ 
void removeStuffFromTextBox(id, stuff)
+ + + + + + + + + + + + + + + +
+ + +

selectOption

+ 
Object selectOption(id, label)
+ +