-
Notifications
You must be signed in to change notification settings - Fork 0
/
jsdoc.php
185 lines (156 loc) · 3.74 KB
/
jsdoc.php
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<?php
//Chemin vers le fichier JS à documenter
define('JS_FILE','C:\chemin\fichier.js');
//Chemin du fichier html de sortie
define('HTML_OUT','C:\chemin\doc.html');
header('Content-Type: text/html; charset=utf-8');
$name = basename(JS_FILE);
$lines = file(JS_FILE);
$methods = array();
for($i=0;$i<count($lines);$i++){
$line = $lines[$i];
$method = array();
preg_match("/\s*(.*)\s*[:=]\s*function\s*\((.*)\)/", $line, $matches);
if(count($matches)==0) continue;
$method['name'] = $matches[1];
$method['args'] = explode(',',$matches[2]);
$method['signature'] = trim(preg_replace("/\s*[:=]\s*function\s*\(/", '(', $matches[0])) ;
$method['static'] = substr($method['name'],0,2)=='$.'?true:false;
$method['description'] = 'Aucune description';
if(!isset($lines[$i-1]) || substr(trim($lines[$i-1]),0,2) != '//') continue;
$method['description'] = substr(trim($lines[$i-1]),2);
for($u=0;$u<count($method['args']);$u++):
$arg = $method['args'][$u];
$method['description'] = str_replace("'".$arg."'","<code>« ".$arg." »</code>",$method['description']);
endfor;
$methods[] = $method;
}
ob_start();
?>
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Documentation <?php echo $name ?></title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
html {
color: #222;
font-size: 1em;
line-height: 1.4;
}
::-moz-selection {
background: #b3d4fc;
text-shadow: none;
}
::selection {
background: #b3d4fc;
text-shadow: none;
}
hr {
display: block;
height: 1px;
border: 0;
border-top: 1px solid #ccc;
margin: 1em 0;
padding: 0;
}
audio,
canvas,
iframe,
img,
svg,
video {
vertical-align: middle;
}
fieldset {
border: 0;
margin: 0;
padding: 0;
}
textarea {
resize: vertical;
}
.list-group a{
display: block;
}
body {
font: 16px/26px Roboto,Helvetica, Helvetica Neue, Arial;
color: #333333;
}
h1,h2,h3{
font-weight: 300;
}
.bold{
font-weight: bold;
}
ul{
padding:0;
margin:0;
}
a{
color:#1D8293;
}
</style>
</head>
<body>
<h1>Javascript :<?php echo $name ?></h1>
<p>Veuillez trouver ci dessous les différentes fonctions javascript du fichier <?php echo $name ?></p>
<ul id="summary">
<?php
$type = '';
//Summary
$i =0;
foreach($methods as $method):
?>
<li>
<?php
if($type != $method['static']){ ?>
<h2>
<?php echo 'METHODES '.($method['static']?'':'NON ').'STATIQUES'; ?>
</h2>
<?php
$type = $method['static'];
}
?>
<a href="#bloc_<?php echo $i; ?>">
<strong><?php echo $method['name']; ?></strong> <i><?php echo implode(',',$method['args']); ?></i> - <small><?php echo $method['description']; ?></small>
</a>
</li>
<?php
$i++;
endforeach;
?>
</ul>
<ul id="detail">
<?php
//Descriptions
$i =0;
foreach($methods as $method):
?>
<li id="bloc_<?php echo $i; ?>">
<div class="tab-pane fade active in" id="home<?php echo $i; ?>">
<h4><?php echo $method['name']; ?><small><?php echo $method['static']?' <span class="label label-warning">Méthode statique</span>':''; ?></small></h4>
<?php if(count($method['args'])>0){ ?> Argument(s) : <i class="label label-primary"><?php echo implode(',',$method['args']); ?></i><?php } ?><br/><br/>
<p><?php echo $method['description']; ?></p>
</div>
<div class="tab-pane fade" id="sample<?php echo $i; ?>">
<pre>
<code><?php echo (!$method['static']?"$('#monElement').":"").$method['signature']; ?></code>
</pre>
</div>
</li>
<?php
$i++;
endforeach;
?>
</ul>
</body>
</html>
<?php
$xml = ob_get_clean();
file_put_contents(HTML_OUT,$xml);
echo 'Doc générée dans '.HTML_OUT;
?>