http://git-wip-us.apache.org/repos/asf/qpid-site/blob/55375a76/input/releases/qpid-python-1.36.0/messaging-api/api/epydoc.js ---------------------------------------------------------------------- diff --git a/input/releases/qpid-python-1.36.0/messaging-api/api/epydoc.js b/input/releases/qpid-python-1.36.0/messaging-api/api/epydoc.js new file mode 100644 index 0000000..e787dbc --- /dev/null +++ b/input/releases/qpid-python-1.36.0/messaging-api/api/epydoc.js @@ -0,0 +1,293 @@ +function toggle_private() { + // Search for any private/public links on this page. Store + // their old text in "cmd," so we will know what action to + // take; and change their text to the opposite action. + var cmd = "?"; + var elts = document.getElementsByTagName("a"); + for(var i=0; i<elts.length; i++) { + if (elts[i].className == "privatelink") { + cmd = elts[i].innerHTML; + elts[i].innerHTML = ((cmd && cmd.substr(0,4)=="show")? + "hide private":"show private"); + } + } + // Update all DIVs containing private objects. + var elts = document.getElementsByTagName("div"); + for(var i=0; i<elts.length; i++) { + if (elts[i].className == "private") { + elts[i].style.display = ((cmd && cmd.substr(0,4)=="hide")?"none":"block"); + } + else if (elts[i].className == "public") { + elts[i].style.display = ((cmd && cmd.substr(0,4)=="hide")?"block":"none"); + } + } + // Update all table rows containing private objects. Note, we + // use "" instead of "block" becaue IE & firefox disagree on what + // this should be (block vs table-row), and "" just gives the + // default for both browsers. + var elts = document.getElementsByTagName("tr"); + for(var i=0; i<elts.length; i++) { + if (elts[i].className == "private") { + elts[i].style.display = ((cmd && cmd.substr(0,4)=="hide")?"none":""); + } + } + // Update all list items containing private objects. + var elts = document.getElementsByTagName("li"); + for(var i=0; i<elts.length; i++) { + if (elts[i].className == "private") { + elts[i].style.display = ((cmd && cmd.substr(0,4)=="hide")? + "none":""); + } + } + // Update all list items containing private objects. + var elts = document.getElementsByTagName("ul"); + for(var i=0; i<elts.length; i++) { + if (elts[i].className == "private") { + elts[i].style.display = ((cmd && cmd.substr(0,4)=="hide")?"none":"block"); + } + } + // Set a cookie to remember the current option. + document.cookie = "EpydocPrivate="+cmd; + } +function show_private() { + var elts = document.getElementsByTagName("a"); + for(var i=0; i<elts.length; i++) { + if (elts[i].className == "privatelink") { + cmd = elts[i].innerHTML; + if (cmd && cmd.substr(0,4)=="show") + toggle_private(); + } + } + } +function getCookie(name) { + var dc = document.cookie; + var prefix = name + "="; + var begin = dc.indexOf("; " + prefix); + if (begin == -1) { + begin = dc.indexOf(prefix); + if (begin != 0) return null; + } else + { begin += 2; } + var end = document.cookie.indexOf(";", begin); + if (end == -1) + { end = dc.length; } + return unescape(dc.substring(begin + prefix.length, end)); + } +function setFrame(url1, url2) { + parent.frames[1].location.href = url1; + parent.frames[2].location.href = url2; + } +function checkCookie() { + var cmd=getCookie("EpydocPrivate"); + if (cmd && cmd.substr(0,4)!="show" && location.href.indexOf("#_") < 0) + toggle_private(); + } +function toggleCallGraph(id) { + var elt = document.getElementById(id); + if (elt.style.display == "none") + elt.style.display = "block"; + else + elt.style.display = "none"; + } +function expand(id) { + var elt = document.getElementById(id+"-expanded"); + if (elt) elt.style.display = "block"; + var elt = document.getElementById(id+"-expanded-linenums"); + if (elt) elt.style.display = "block"; + var elt = document.getElementById(id+"-collapsed"); + if (elt) { elt.innerHTML = ""; elt.style.display = "none"; } + var elt = document.getElementById(id+"-collapsed-linenums"); + if (elt) { elt.innerHTML = ""; elt.style.display = "none"; } + var elt = document.getElementById(id+"-toggle"); + if (elt) { elt.innerHTML = "-"; } +} + +function collapse(id) { + var elt = document.getElementById(id+"-expanded"); + if (elt) elt.style.display = "none"; + var elt = document.getElementById(id+"-expanded-linenums"); + if (elt) elt.style.display = "none"; + var elt = document.getElementById(id+"-collapsed-linenums"); + if (elt) { elt.innerHTML = "<br />"; elt.style.display="block"; } + var elt = document.getElementById(id+"-toggle"); + if (elt) { elt.innerHTML = "+"; } + var elt = document.getElementById(id+"-collapsed"); + if (elt) { + elt.style.display = "block"; + + var indent = elt.getAttribute("indent"); + var pad = elt.getAttribute("pad"); + var s = "<tt class='py-lineno'>"; + for (var i=0; i<pad.length; i++) { s += " " } + s += "</tt>"; + s += " <tt class='py-line'>"; + for (var i=0; i<indent.length; i++) { s += " " } + s += "<a href='#' onclick='expand(\"" + id; + s += "\");return false'>...</a></tt><br />"; + elt.innerHTML = s; + } +} + +function toggle(id) { + elt = document.getElementById(id+"-toggle"); + if (elt.innerHTML == "-") + collapse(id); + else + expand(id); + return false; +} + +function highlight(id) { + var elt = document.getElementById(id+"-def"); + if (elt) elt.className = "py-highlight-hdr"; + var elt = document.getElementById(id+"-expanded"); + if (elt) elt.className = "py-highlight"; + var elt = document.getElementById(id+"-collapsed"); + if (elt) elt.className = "py-highlight"; +} + +function num_lines(s) { + var n = 1; + var pos = s.indexOf("\n"); + while ( pos > 0) { + n += 1; + pos = s.indexOf("\n", pos+1); + } + return n; +} + +// Collapse all blocks that mave more than `min_lines` lines. +function collapse_all(min_lines) { + var elts = document.getElementsByTagName("div"); + for (var i=0; i<elts.length; i++) { + var elt = elts[i]; + var split = elt.id.indexOf("-"); + if (split > 0) + if (elt.id.substring(split, elt.id.length) == "-expanded") + if (num_lines(elt.innerHTML) > min_lines) + collapse(elt.id.substring(0, split)); + } +} + +function expandto(href) { + var start = href.indexOf("#")+1; + if (start != 0 && start != href.length) { + if (href.substring(start, href.length) != "-") { + collapse_all(4); + pos = href.indexOf(".", start); + while (pos != -1) { + var id = href.substring(start, pos); + expand(id); + pos = href.indexOf(".", pos+1); + } + var id = href.substring(start, href.length); + expand(id); + highlight(id); + } + } +} + +function kill_doclink(id) { + var parent = document.getElementById(id); + parent.removeChild(parent.childNodes.item(0)); +} +function auto_kill_doclink(ev) { + if (!ev) var ev = window.event; + if (!this.contains(ev.toElement)) { + var parent = document.getElementById(this.parentID); + parent.removeChild(parent.childNodes.item(0)); + } +} + +function doclink(id, name, targets_id) { + var elt = document.getElementById(id); + + // If we already opened the box, then destroy it. + // (This case should never occur, but leave it in just in case.) + if (elt.childNodes.length > 1) { + elt.removeChild(elt.childNodes.item(0)); + } + else { + // The outer box: relative + inline positioning. + var box1 = document.createElement("div"); + box1.style.position = "relative"; + box1.style.display = "inline"; + box1.style.top = 0; + box1.style.left = 0; + + // A shadow for fun + var shadow = document.createElement("div"); + shadow.style.position = "absolute"; + shadow.style.left = "-1.3em"; + shadow.style.top = "-1.3em"; + shadow.style.background = "#404040"; + + // The inner box: absolute positioning. + var box2 = document.createElement("div"); + box2.style.position = "relative"; + box2.style.border = "1px solid #a0a0a0"; + box2.style.left = "-.2em"; + box2.style.top = "-.2em"; + box2.style.background = "white"; + box2.style.padding = ".3em .4em .3em .4em"; + box2.style.fontStyle = "normal"; + box2.onmouseout=auto_kill_doclink; + box2.parentID = id; + + // Get the targets + var targets_elt = document.getElementById(targets_id); + var targets = targets_elt.getAttribute("targets"); + var links = ""; + target_list = targets.split(","); + for (var i=0; i<target_list.length; i++) { + var target = target_list[i].split("="); + links += "<li><a href='" + target[1] + + "' style='text-decoration:none'>" + + target[0] + "</a></li>"; + } + + // Put it all together. + elt.insertBefore(box1, elt.childNodes.item(0)); + //box1.appendChild(box2); + box1.appendChild(shadow); + shadow.appendChild(box2); + box2.innerHTML = + "Which <b>"+name+"</b> do you want to see documentation for?" + + "<ul style='margin-bottom: 0;'>" + + links + + "<li><a href='#' style='text-decoration:none' " + + "onclick='kill_doclink(\""+id+"\");return false;'>"+ + "<i>None of the above</i></a></li></ul>"; + } + return false; +} + +function get_anchor() { + var href = location.href; + var start = href.indexOf("#")+1; + if ((start != 0) && (start != href.length)) + return href.substring(start, href.length); + } +function redirect_url(dottedName) { + // Scan through each element of the "pages" list, and check + // if "name" matches with any of them. + for (var i=0; i<pages.length; i++) { + + // Each page has the form "<pagename>-m" or "<pagename>-c"; + // extract the <pagename> portion & compare it to dottedName. + var pagename = pages[i].substring(0, pages[i].length-2); + if (pagename == dottedName.substring(0,pagename.length)) { + + // We've found a page that matches `dottedName`; + // construct its URL, using leftover `dottedName` + // content to form an anchor. + var pagetype = pages[i].charAt(pages[i].length-1); + var url = pagename + ((pagetype=="m")?"-module.html": + "-class.html"); + if (dottedName.length > pagename.length) + url += "#" + dottedName.substring(pagename.length+1, + dottedName.length); + return url; + } + } + }
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/55375a76/input/releases/qpid-python-1.36.0/messaging-api/api/frames.html ---------------------------------------------------------------------- diff --git a/input/releases/qpid-python-1.36.0/messaging-api/api/frames.html b/input/releases/qpid-python-1.36.0/messaging-api/api/frames.html new file mode 100644 index 0000000..f628a76 --- /dev/null +++ b/input/releases/qpid-python-1.36.0/messaging-api/api/frames.html @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" + "DTD/xhtml1-frameset.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title> Qpid Python Messaging API </title> +</head> +<frameset cols="20%,80%"> + <frameset rows="30%,70%"> + <frame src="toc.html" name="moduleListFrame" + id="moduleListFrame" /> + <frame src="toc-everything.html" name="moduleFrame" + id="moduleFrame" /> + </frameset> + <frame src="qpid.messaging-module.html" name="mainFrame" id="mainFrame" /> +</frameset> +</html> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/55375a76/input/releases/qpid-python-1.36.0/messaging-api/api/help.html ---------------------------------------------------------------------- diff --git a/input/releases/qpid-python-1.36.0/messaging-api/api/help.html b/input/releases/qpid-python-1.36.0/messaging-api/api/help.html new file mode 100644 index 0000000..5de76eb --- /dev/null +++ b/input/releases/qpid-python-1.36.0/messaging-api/api/help.html @@ -0,0 +1,276 @@ +<?xml version="1.0" encoding="ascii"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>Help</title> + <link rel="stylesheet" href="epydoc.css" type="text/css" /> + <script type="text/javascript" src="epydoc.js"></script> +</head> + +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="qpid.messaging-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th bgcolor="#70b0f0" class="navbar-select" + > Help </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + ><a class="navbar" target="_top" href="http://qpid.apache.org/index.html">Qpid Python Messaging API</a></th> + </tr></table></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> </td> + <td> + <table cellpadding="0" cellspacing="0"> + <!-- hide/show private --> + <tr><td align="right"><span class="options" + >[<a href="frames.html" target="_top">frames</a + >] | <a href="help.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> + +<h1 class="epydoc"> API Documentation </h1> + +<p> This document contains the API (Application Programming Interface) +documentation for Qpid Python Messaging API. Documentation for the Python +objects defined by the project is divided into separate pages for each +package, module, and class. The API documentation also includes two +pages containing information about the project as a whole: a trees +page, and an index page. </p> + +<h2> Object Documentation </h2> + + <p>Each <strong>Package Documentation</strong> page contains: </p> + <ul> + <li> A description of the package. </li> + <li> A list of the modules and sub-packages contained by the + package. </li> + <li> A summary of the classes defined by the package. </li> + <li> A summary of the functions defined by the package. </li> + <li> A summary of the variables defined by the package. </li> + <li> A detailed description of each function defined by the + package. </li> + <li> A detailed description of each variable defined by the + package. </li> + </ul> + + <p>Each <strong>Module Documentation</strong> page contains:</p> + <ul> + <li> A description of the module. </li> + <li> A summary of the classes defined by the module. </li> + <li> A summary of the functions defined by the module. </li> + <li> A summary of the variables defined by the module. </li> + <li> A detailed description of each function defined by the + module. </li> + <li> A detailed description of each variable defined by the + module. </li> + </ul> + + <p>Each <strong>Class Documentation</strong> page contains: </p> + <ul> + <li> A class inheritance diagram. </li> + <li> A list of known subclasses. </li> + <li> A description of the class. </li> + <li> A summary of the methods defined by the class. </li> + <li> A summary of the instance variables defined by the class. </li> + <li> A summary of the class (static) variables defined by the + class. </li> + <li> A detailed description of each method defined by the + class. </li> + <li> A detailed description of each instance variable defined by the + class. </li> + <li> A detailed description of each class (static) variable defined + by the class. </li> + </ul> + +<h2> Project Documentation </h2> + + <p> The <strong>Trees</strong> page contains the module and class hierarchies: </p> + <ul> + <li> The <em>module hierarchy</em> lists every package and module, with + modules grouped into packages. At the top level, and within each + package, modules and sub-packages are listed alphabetically. </li> + <li> The <em>class hierarchy</em> lists every class, grouped by base + class. If a class has more than one base class, then it will be + listed under each base class. At the top level, and under each base + class, classes are listed alphabetically. </li> + </ul> + + <p> The <strong>Index</strong> page contains indices of terms and + identifiers: </p> + <ul> + <li> The <em>term index</em> lists every term indexed by any object's + documentation. For each term, the index provides links to each + place where the term is indexed. </li> + <li> The <em>identifier index</em> lists the (short) name of every package, + module, class, method, function, variable, and parameter. For each + identifier, the index provides a short description, and a link to + its documentation. </li> + </ul> + +<h2> The Table of Contents </h2> + +<p> The table of contents occupies the two frames on the left side of +the window. The upper-left frame displays the <em>project +contents</em>, and the lower-left frame displays the <em>module +contents</em>: </p> + +<table class="help summary" border="1" cellspacing="0" cellpadding="3"> + <tr style="height: 30%"> + <td align="center" style="font-size: small"> + Project<br />Contents<hr />...</td> + <td align="center" style="font-size: small" rowspan="2" width="70%"> + API<br />Documentation<br />Frame<br /><br /><br /> + </td> + </tr> + <tr> + <td align="center" style="font-size: small"> + Module<br />Contents<hr /> <br />...<br /> + </td> + </tr> +</table><br /> + +<p> The <strong>project contents frame</strong> contains a list of all packages +and modules that are defined by the project. Clicking on an entry +will display its contents in the module contents frame. Clicking on a +special entry, labeled "Everything," will display the contents of +the entire project. </p> + +<p> The <strong>module contents frame</strong> contains a list of every +submodule, class, type, exception, function, and variable defined by a +module or package. Clicking on an entry will display its +documentation in the API documentation frame. Clicking on the name of +the module, at the top of the frame, will display the documentation +for the module itself. </p> + +<p> The "<strong>frames</strong>" and "<strong>no frames</strong>" buttons below the top +navigation bar can be used to control whether the table of contents is +displayed or not. </p> + +<h2> The Navigation Bar </h2> + +<p> A navigation bar is located at the top and bottom of every page. +It indicates what type of page you are currently viewing, and allows +you to go to related pages. The following table describes the labels +on the navigation bar. Note that not some labels (such as +[Parent]) are not displayed on all pages. </p> + +<table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%"> +<tr class="summary"> + <th>Label</th> + <th>Highlighted when...</th> + <th>Links to...</th> +</tr> + <tr><td valign="top"><strong>[Parent]</strong></td> + <td valign="top"><em>(never highlighted)</em></td> + <td valign="top"> the parent of the current package </td></tr> + <tr><td valign="top"><strong>[Package]</strong></td> + <td valign="top">viewing a package</td> + <td valign="top">the package containing the current object + </td></tr> + <tr><td valign="top"><strong>[Module]</strong></td> + <td valign="top">viewing a module</td> + <td valign="top">the module containing the current object + </td></tr> + <tr><td valign="top"><strong>[Class]</strong></td> + <td valign="top">viewing a class </td> + <td valign="top">the class containing the current object</td></tr> + <tr><td valign="top"><strong>[Trees]</strong></td> + <td valign="top">viewing the trees page</td> + <td valign="top"> the trees page </td></tr> + <tr><td valign="top"><strong>[Index]</strong></td> + <td valign="top">viewing the index page</td> + <td valign="top"> the index page </td></tr> + <tr><td valign="top"><strong>[Help]</strong></td> + <td valign="top">viewing the help page</td> + <td valign="top"> the help page </td></tr> +</table> + +<p> The "<strong>show private</strong>" and "<strong>hide private</strong>" buttons below +the top navigation bar can be used to control whether documentation +for private objects is displayed. Private objects are usually defined +as objects whose (short) names begin with a single underscore, but do +not end with an underscore. For example, "<code>_x</code>", +"<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>" +are private objects; but "<code>re.sub</code>", +"<code>__init__</code>", and "<code>type_</code>" are not. However, +if a module defines the "<code>__all__</code>" variable, then its +contents are used to decide which objects are private. </p> + +<p> If --include-timestamp was passed, a timestamp below the bottom navigation bar indicates +when each page was last updated. </p> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="qpid.messaging-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th bgcolor="#70b0f0" class="navbar-select" + > Help </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + ><a class="navbar" target="_top" href="http://qpid.apache.org/index.html">Qpid Python Messaging API</a></th> + </tr></table></th> + </tr> +</table> +<table border="0" cellpadding="0" cellspacing="0" width="100%%"> + <tr> + <td align="left" class="footer"> + Generated by Epydoc 3.0.1 + </td> + <td align="right" class="footer"> + <a target="mainFrame" href="http://epydoc.sourceforge.net" + >http://epydoc.sourceforge.net</a> + </td> + </tr> +</table> + +<script type="text/javascript"> + <!-- + // Private objects are initially displayed (because if + // javascript is turned off then we want them to be + // visible); but by default, we want to hide them. So hide + // them unless we have a cookie that says to show them. + checkCookie(); + // --> +</script> +</body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org