← Back to branch summary

~jstys-z/helioviewer.org/client5

« back to all changes in this revision

Viewing changes to docs/server-side/Helioviewer/API.html

  • Committer: V. Keith Hughitt
  • Date: 2009-04-01 21:08:05 UTC
  • Revision ID: hughitt1@kore-20090401210805-372f7dgih07vxk42
nightly build 04-01-2009

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/server-side/Helioviewer/API.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
  <html xmlns="http://www.w3.org/1999/xhtml">
 
4
                <head>
 
5
                        <!-- template designed by Marco Von Ballmoos -->
 
6
                        <title>Docs For Class API</title>
 
7
                        <link rel="stylesheet" href="../media/stylesheet.css" />
 
8
                        <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
 
9
                </head>
 
10
                <body>
 
11
                        <div class="page-body">                 
 
12
<h2 class="class-name"><img src="../media/images/Class_logo.png"
 
13
                                                                                                                alt=" Class"
 
14
                                                                                                                title=" Class"
 
15
                                                                                                                style="vertical-align: middle"> API</h2>
 
16
 
 
17
<a name="sec-description"></a>
 
18
<div class="info-box">
 
19
        <div class="info-box-title">Description</div>
 
20
        <div class="nav-bar">
 
21
                                        <span class="disabled">Description</span> |
 
22
                                                                                                                        <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 
23
                                                
 
24
                                        </div>
 
25
        <div class="info-box-body">
 
26
                        <!-- ========== Info from phpDoc block ========= -->
 
27
                <p class="notes">
 
28
                        Located in <a class="field" href="_API.php.html">/API.php</a> (line <span class="field">10</span>)
 
29
                </p>
 
30
                
 
31
                                
 
32
                <pre></pre>
 
33
        
 
34
                        </div>
 
35
</div>
 
36
 
 
37
 
 
38
 
 
39
 
 
40
        <a name="sec-method-summary"></a>
 
41
        <div class="info-box">
 
42
                <div class="info-box-title">Method Summary</span></div>
 
43
                <div class="nav-bar">
 
44
                        <a href="#sec-description">Description</a> |
 
45
                                                                                                <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
 
46
                </div>
 
47
                <div class="info-box-body">                     
 
48
                        <div class="method-summary">
 
49
                                                                                                                                                                                                <div class="method-definition">
 
50
                                        <img src="../media/images/Constructor.png" alt=" "/>
 
51
                                                                                        <span class="method-result">API</span>
 
52
                                                                                <a href="#__construct" title="details" class="method-name">__construct</a>
 
53
                                                                                        (<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$format</span>)
 
54
                                                                        </div>
 
55
                                                                                        </div>
 
56
                </div>
 
57
        </div>          
 
58
 
 
59
        
 
60
        <a name="sec-methods"></a>
 
61
        <div class="info-box">
 
62
                <div class="info-box-title">Methods</div>
 
63
                <div class="nav-bar">
 
64
                        <a href="#sec-description">Description</a> |
 
65
                                                                                                        <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 
66
                                                
 
67
                </div>
 
68
                <div class="info-box-body">
 
69
                        <A NAME='method_detail'></A>
 
70
<a name="method__construct" id="__construct"><!-- --></a>
 
71
<div class="evenrow">
 
72
        
 
73
        <div class="method-header">
 
74
                <img src="../media/images/Constructor.png" />
 
75
                <span class="method-title">Constructor __construct</span> (line <span class="line-number">16</span>)
 
76
        </div> 
 
77
        
 
78
        <!-- ========== Info from phpDoc block ========= -->
 
79
        <ul class="tags">
 
80
                                <li><span class="field">access:</span> public</li>
 
81
                        </ul>
 
82
        
 
83
        <div class="method-signature">
 
84
                <span class="method-result">API</span>
 
85
                <span class="method-name">
 
86
                        __construct
 
87
                </span>
 
88
                                        (<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$format</span>)
 
89
                        </div>
 
90
        
 
91
                        <ul class="parameters">
 
92
                                        <li>
 
93
                                <span class="var-type">array</span>
 
94
                                <span class="var-name">$params</span><span class="var-description">: An array of parameters relevant to the API call</span>                     </li>
 
95
                                        <li>
 
96
                                <span class="var-type">string</span>
 
97
                                <span class="var-name">$format</span><span class="var-description">: [&quot;plain-text&quot;|&quot;json&quot;] The format to return results in</span>                   </li>
 
98
                                </ul>
 
99
                
 
100
                        
 
101
        </div>
 
102
                                                
 
103
                </div>
 
104
        </div>
 
105
 
 
106
        
 
107
        <p class="notes" id="credit">
 
108
                Documentation generated on Fri, 20 Mar 2009 16:29:57 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
 
109
        </p>
 
110
        </div></body>
 
111
</html>
 
 
b'\\ No newline at end of file'