-
Notifications
You must be signed in to change notification settings - Fork 0
/
doxygen-filter_8php.html
169 lines (163 loc) · 7.22 KB
/
doxygen-filter_8php.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Automatische Punkteauswertung des RoboSAX: doxygen-filter.php File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Automatische Punkteauswertung des RoboSAX
 <span id="projectnumber">0.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">doxygen-filter.php File Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a6e477ab475043b866f7f46086e29e15b"><td class="memItemLeft" align="right" valign="top">const </td><td class="memItemRight" valign="bottom"><a class="el" href="doxygen-filter_8php.html#a6e477ab475043b866f7f46086e29e15b">NSS</a> '::'</td></tr>
<tr class="separator:a6e477ab475043b866f7f46086e29e15b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99a2b085f0a29bd5d799fdcbb63d261b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="doxygen-filter_8php.html#a99a2b085f0a29bd5d799fdcbb63d261b">$source</a> = file_get_contents($_SERVER['argv'][1])</td></tr>
<tr class="separator:a99a2b085f0a29bd5d799fdcbb63d261b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72ead29e4317fbc4335fd3ba764e8b59"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="doxygen-filter_8php.html#a72ead29e4317fbc4335fd3ba764e8b59">$tokens</a> = token_get_all($source)</td></tr>
<tr class="separator:a72ead29e4317fbc4335fd3ba764e8b59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1862006a19e84e552f66189adc792ae"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="doxygen-filter_8php.html#af1862006a19e84e552f66189adc792ae">$buffer</a> = null</td></tr>
<tr class="separator:af1862006a19e84e552f66189adc792ae"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="af1862006a19e84e552f66189adc792ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$buffer = null</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a99a2b085f0a29bd5d799fdcbb63d261b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$source = file_get_contents($_SERVER['argv'][1])</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a72ead29e4317fbc4335fd3ba764e8b59"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$tokens = token_get_all($source)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a6e477ab475043b866f7f46086e29e15b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const NSS '::'</td>
</tr>
</table>
</div><div class="memdoc">
<p>Simple input filter for using Doxygen with PHP code</p>
<p>It optimize the documention like:</p><ul>
<li>rewrites php namespaces to use :: instead of \</li>
<li>replaces @return with @retval</li>
<li>appends variable names to @var commands</li>
<li>remove unused annotations @codeCoverageIgnore</li>
</ul>
<dl class="section see"><dt>See also</dt><dd><a href="http://www.doxygen.org/">http://www.doxygen.org/</a> </dd>
<dd>
<a href="http://www.stack.nl/~dimitri/doxygen/config.html#cfg_input_filter">http://www.stack.nl/~dimitri/doxygen/config.html#cfg_input_filter</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Mar 14 2021 23:16:52 for Automatische Punkteauswertung des RoboSAX by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>