-
Notifications
You must be signed in to change notification settings - Fork 34
/
deprecated.html
740 lines (663 loc) · 25.9 KB
/
deprecated.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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
<!DOCTYPE html>
<html>
<head>
<title>apiDoc - Deprecated apiDoc params</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="http://fonts.googleapis.com/css?family=Source+Code+Pro|Source+Sans+Pro:400,700" rel="stylesheet" type="text/css">
<link href="css/easy-responsive-tabs.css" rel="stylesheet" media="screen">
<link href="css/style.css" rel="stylesheet" media="screen">
<link href="img/favicon.ico" rel="icon" type="image/x-icon">
</head>
<body>
<nav class="nav-top">
<a id="forkme" href="https://github.com/apidoc/apidoc"><img src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"></a>
<ul role="list">
<li role="listitem"><a href="index.html">Home</a></li>
</ul>
</nav>
<div class="container">
<header role="banner">
<div class="pull-left span9">
<h1>APIDOC</h1>
<h2>Inline Documentation for RESTful web APIs</h2>
<h3>apiDoc creates a documentation from API annotations in your source code.</h3>
</div>
</header>
<div id="main">
<aside>
<nav class="nav-main" role="navigation">
<ul role="list">
<li role="listitem" id="nav-main-params" class="nav-header"><a href="#params">Deprecated<br>apiDoc-Params</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-define-error-structure">@apiDefineErrorStructure</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-define-header-structure">@apiDefineHeaderStructure</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-define-permission">@apiDefinePermission</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-define-structure">@apiDefineStructure</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-define-success-structure">@apiDefineSuccessStructure</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-error-structure">@apiErrorStructure</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-error-title">@apiErrorTitle</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-group-description">@apiGroupDescription</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-header-structure">@apiHeaderStructure</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-header-title">@apiHeaderTitle</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-param-title">@apiParamTitle</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-structure">@apiStructure</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-success-structure">@apiSuccessStructure</a></li>
<li role="listitem" class="deprecated"><a href="#param-api-success-title">@apiSuccessTitle</a></li>
<li role="listitem" class="nav-header"><a href="index.html#params">Back to current version</a></li>
</ul>
</nav>
</aside>
<div id="content" role="main">
<!--
/* ============================================================
* Params
* ============================================================ */
-->
<section id="params">
<h1>Deprecated apiDoc-Params</h1>
<p>Please use only <a href="index.html#params">current params</a>.</p>
<article id="param-api-define-error-structure">
<h2>@apiDefineErrorStructure</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-define">@apiDefine</a></p>
<pre><code>@apiDefineErrorStructure name</code></pre>
<p>Defines a documentation block as a draft to be used in normal <code>@api</code> blocks.</p>
<p>Should be used to define Error Parameters, like <code>@apiError</code>, <code>@apiErrorExample</code>.</p>
<p>Usage: <code>@apiDefineErrorStructure MyError</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">name</td>
<td>
Unique name for the block.<br>
Same name with different <code>@apiVersion</code> can be defined.
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<pre class="example"><code>/**
* @apiDefineErrorStructure MyError
* @apiError UserNotFound The <code>id</code> of the User was not found.
*/
/**
* @api {get} /user/:id
* @apiErrorStructure MyError
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-define-header-structure">
<h2>@apiDefineHeaderStructure</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-define">@apiDefine</a></p>
<pre><code>@apiDefineHeaderStructure name</code></pre>
<p>Defines a documentation block as a draft to be used in normal <code>@api</code> blocks.</p>
<p>Should be used to define Header Parameters, like <code>@apiHeader</code>, <code>@apiHeaderExample</code>.</p>
<p class="similar-operation">Similar operation as <a href="#param-api-define-structure">@apiDefineStructure</a>.</p>
<p>Usage: <code>@apiDefineHeaderStructure MyHeader</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">name</td>
<td>
Unique name for the block.<br>
Same name with different <code>@apiVersion</code> can be defined.
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<pre class="example"><code>/**
* @apiDefineHeaderStructure MyHeader
* @apiHeader {String} firstname Firstname of the User.
*/
/**
* @api {get} /user/:id
* @apiHeaderStructure MyHeader
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-define-permission">
<h2>@apiDefinePermission</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-define">@apiDefine</a></p>
<pre><code>@apiDefinePermission name [title]
[description]</code></pre>
<p>Defines a permission as a draft to be used in normal <code>@api</code> blocks.</p>
<p>Usage: <code>@apiDefinePermission admin</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">name</td>
<td>
Unique name for the Permission.<br>
Same name with different <code>@apiVersion</code> can be defined.
</td>
</tr>
<tr>
<td class="code">title <span class="label label-optional">optional</span></td>
<td>
A short title.
</td>
</tr>
<tr>
<td class="code">description <span class="label label-optional">optional</span></td>
<td>
Detailed Description start at the next line, multiple lines can be used.
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<pre class="example"><code>/**
* @apiDefinePermission admin Admin access rights needed.
* Optionally you can write here further Informations about the permission.
*/
/**
* @api {get} /user/:id
* @apiPermission admin
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-define-structure">
<h2>@apiDefineStructure</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-define">@apiDefine</a></p>
<pre><code>@apiDefineStructure name</code></pre>
<p>Defines a documentation block as a draft to be used in normal <code>@api</code> blocks.</p>
<p>Should be used to define normal Parameters, like <code>@apiParam</code>, <code>@apiExample</code></p>
<p>Usage: <code>@apiDefineStructure MyName</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">name</td>
<td>
Unique name for the block.<br>
Same name with different <code>@apiVersion</code> can be defined.
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<pre class="example"><code>/**
* @apiDefineStructure MyName
* @apiParam {Number} id Users unique ID.
*/
/**
* @api {get} /user/:id
* @apiStructure MyName
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-define-success-structure">
<h2>@apiDefineSuccessStructure</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-define">@apiDefine</a></p>
<pre><code>@apiDefineSuccessStructure name</code></pre>
<p>Defines a documentation block as a draft to be used in normal <code>@api</code> blocks.</p>
<p>Should be used to define Success Parameters, like <code>@apiSuccess</code>, <code>@apiSuccessExample</code>.</p>
<p>Usage: <code>@apiDefineSuccessStructure MySuccess</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">name</td>
<td>
Unique name for the block.<br>
Same name with different <code>@apiVersion</code> can be defined.
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<pre class="example"><code>/**
* @apiDefineSuccessStructure MySuccess
* @apiSuccess {String} firstname Firstname of the User.
*/
/**
* @api {get} /user/:id
* @apiSuccessStructure MySuccess
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-error-structure">
<h2>@apiErrorStructure</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-use">@apiUse</a></p>
<pre><code>@apiErrorStructure name</code></pre>
<p>Include a with <code>@apiDefineErrorStructure</code> defined block. If used with <code>@apiVersion</code> the same or nearest predecessor will be included.</p>
<p>Usage: <code>@apiErrorStructure MyError</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">name</td>
<td>
Name of the defined error block.
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<pre class="example"><code>/**
* @api {get} /user/:id
* @apiErrorStructure MyError
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-error-title">
<h2>@apiErrorTitle</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-define">@apiDefine</a></p>
<pre><code>@apiErrorTitle (group) description</code></pre>
<p>Replace the short group-name with a description</p>
<p><strong>Global usage, use it once, no versioning. Optional.</strong></p>
<p>Usage: <code>@apiErrorTitle (MyGroup) This are the Parameters for MyGroup:</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">(group)</td>
<td>
All errors will be grouped by this name.<br>
</td>
</tr>
<tr>
<td class="code">description</td>
<td>
In documentation the short group-name will be replaced with the description.
</td>
</tr>
</tbody>
</table>
<p>Examples:</p>
<pre class="example"><code>/**
* @api {post} /user/
*
* @apiErrorTitle (401) 401 Unauthorized
* @apiError (401) notAuthorizedError User not found.
*
* @apiErrorTitle (404) 404 Not Found
* @apiError (404) notFoundError Data not found.
*
* @apiError (500) serverError apiErrorTitle is not needed.
*/
Example without @apiErrorTitle:
/**
* @api {post} /user/
* @apiError (401 Unauthorized) notAuthorizedError User not found.
* @apiError (404 Not Found) notFoundError Data not found.
* @apiError (500) serverError apiErrorTitle is not needed.
*/
</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-group-description">
<h2>@apiGroupDescription</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-use">@apiDefine</a></p>
<pre><code>@apiGroupDescription text</code></pre>
<p><strong>Singleton usage at the moment. Use the tag only once for a group.</strong></p>
<p>Detailed description of the Group, it will be in the documentation at the beginning of a group.</p>
<p>Usage: <code>@apiGroupDescription Some information about the group</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">text</td>
<td>
Multiline description text.
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<pre class="example"><code>/**
* @api {get} /user/:id
* @apiGroup User
* @apiGroupDescription The User-Group description.
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-header-structure">
<h2>@apiHeaderStructure</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-use">@apiUse</a></p>
<pre><code>@apiHeaderStructure name</code></pre>
<p>Include a with <code>@apiDefineHeaderStructure</code> defined block. If used with <code>@apiVersion</code> the same or nearest predecessor will be included.</p>
<p class="similar-operation">Similar operation as <a href="#param-api-structure">@apiStructure</a>.</p>
<p>Usage: <code>@apiHeaderStructure MyHeader</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">name</td>
<td>
Name of the defined header block.
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<pre class="example"><code>/**
* @api {get} /user/:id
* @apiHeaderStructure MyHeader
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-header-title">
<h2>@apiHeaderTitle</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-define">@apiDefine</a></p>
<pre><code>@apiHeaderTitle (group) description</code></pre>
<p>Replace the short group-name with a description</p>
<p><strong>Global usage, use it once, no versioning. Optional.</strong></p>
<p class="similar-operation">Similar operation as <a href="#param-api-param-title">@apiParamTitle</a>.</p>
<p>Usage: <code>@apiHeaderTitle (MyHeaderGroup) This are the Parameters for MyHeaderGroup:</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">(group)</td>
<td>
All parameters will be grouped by this name.<br>
</td>
</tr>
<tr>
<td class="code">description</td>
<td>
In documentation the short group-name will be replaced with the description.
</td>
</tr>
</tbody>
</table>
<p>Examples:</p>
<pre class="example"><code>/**
* @api {post} /user/
*
* @apiHeaderTitle (Auth) Parameters only for loggedin users:
* @apiHeader (Auth) {String} key Users unique access-key.
* @apiHeader (Auth) {String} system-key Access-key from external system.
*/</code></pre>
<p>Example without @apiHeaderTitle:</p>
<pre class="example"><code>/**
* @api {post} /user/
*
* @apiHeader (Parameters only for loggedin users:) {String} key Users unique access-key.
* @apiHeader (Parameters only for loggedin users:) {String} system-key Access-key from external system.
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-param-title">
<h2>@apiParamTitle</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-define">@apiDefine</a></p>
<pre><code>@apiParamTitle (group) description</code></pre>
<p>Replace the short group-name with a description</p>
<p><strong>Global usage, use it once, no versioning. Optional.</strong></p>
<p>Usage: <code>@apiParamTitle (MyGroup) This are the Parameters for MyGroup:</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">(group)</td>
<td>
All parameters will be grouped by this name.<br>
</td>
</tr>
<tr>
<td class="code">description</td>
<td>
In documentation the short group-name will be replaced with the description.
</td>
</tr>
</tbody>
</table>
<p>Examples:</p>
<pre class="example"><code>/**
* @api {post} /user/
*
* @apiParamTitle (Login) Parameters only for loggedin users:
* @apiParam (Login) {String} newPassword New password.
*
* @apiParamTitle (Admin) Parameters only for admin users:
* @apiParam (Admin) {String} newPassword New password.
* @apiParam (Admin) {String} userId Change password of that user.
*/</code></pre>
<p>Example without @apiParamTitle:</p>
<pre class="example"><code>/**
* @api {post} /user/
*
* @apiParam (Parameters only for loggedin users:) {String} newPassword New password.
*
* @apiParam (Parameters only for admin users:) {String} newPassword New password.
* @apiParam (Parameters only for admin users:) {String} userId Change password of that user.
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-structure">
<h2>@apiStructure</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-use">@apiUse</a></p>
<pre><code>@apiStructure name</code></pre>
<p>Include a with <code>@apiDefineStructure</code> defined block. If used with <code>@apiVersion</code> the same or nearest predecessor will be included.</p>
<p>Usage: <code>@apiStructure MyStructure</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">name</td>
<td>
Name of the defined block.
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<pre class="example"><code>/**
* @api {get} /user/:id
* @apiStructure MyStructure
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-success-structure">
<h2>@apiSuccessStructure</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-use">@apiUse</a></p>
<pre><code>@apiSuccessStructure name</code></pre>
<p>Include a with <code>@apiDefineSuccessStructure</code> defined block. If used with <code>@apiVersion</code> the same or nearest predecessor will be included.</p>
<p>Usage: <code>@apiSuccessStructure MySuccess</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">name</td>
<td>
Name of the defined success block.
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<pre class="example"><code>/**
* @api {get} /user/:id
* @apiSuccessStructure MySuccess
*/</code></pre>
</article>
<!-- ============================================================ -->
<article id="param-api-success-title">
<h2>@apiSuccessTitle</h2>
<p><span class="deprecated">Deprecated !</span> Use <a href="index.html#param-api-define">@apiDefine</a></p>
<pre><code>@apiSuccessTitle (group) description</code></pre>
<p>Replace the short group-name with a description</p>
<p><strong>Global usage, use it once, no versioning. Optional.</strong></p>
<p>Usage: <code>@apiSuccessTitle (MyGroup) This are the Parameters for MyGroup:</code></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">(group)</td>
<td>
All success messages will be grouped by this name.<br>
</td>
</tr>
<tr>
<td class="code">description</td>
<td>
In documentation the short group-name will be replaced with the description.
</td>
</tr>
</tbody>
</table>
<p>Examples:</p>
<pre class="example"><code>/**
* @api {post} /user/
* @apiSuccessTitle (All) 200 - Data for all users:
* @apiSuccess (All) id The ID of a user.
* @apiSuccess (All) name The name of a user.
*
* @apiSuccessTitle (LoggedIn) Data for LoggedIn users:
* @apiSuccess (LoggedIn) id The ID of a user.
* @apiSuccess (LoggedIn) name The name of a user.
* @apiSuccess (LoggedIn) email E-Mail address of a user.
*/
Example without @apiErrorTitle:
/**
* @api {post} /user/
* @apiSuccess (200 - Data for all users:) id The ID of a user.
* @apiSuccess (200 - Data for all users:) name The name of a user.
*
* @apiSuccess (Data for LoggedIn users:) id The ID of a user.
* @apiSuccess (Data for LoggedIn users:) name The name of a user.
* @apiSuccess (Data for LoggedIn users:) email E-Mail address of a user.
*/
</code></pre>
</article>
<!-- ============================================================ -->
</section>
<!--
/* ============================================================
* License
* ============================================================ */
-->
<section id="license">
<article>
<h1>MIT License</h1>
<p>
<a href="https://github.com/apidoc/apidoc/blob/master/LICENSE">github.com/apidoc/apidoc/blob/master/LICENSE</a><br>
Copyright (c) 2013-2015 inveris OHG<br>
Author Peter Rottmann
</p>
<p><br></p>
<p>Contact, support and error reporting on GitHub: <a href="https://github.com/apidoc/grunt-apidoc/issues">github.com/apidoc/apidoc/issues</a></p>
</article>
</section>
<footer class="contentinfo">
development is supported by <a href="http://www.inveris.de">inveris</a> •
hosted on <a href="https://github.com/apidoc/apidoc">GitHub</a> •
distributed over <a href="https://npmjs.org/package/apidoc">npm</a>
</footer>
</div><!-- /#content -->
</div><!-- /#main -->
</div><!-- /.container -->
<script src="http://code.jquery.com/jquery-1.11.0.min.js"></script>
<script>
$(document).ready(function() {
var headerSize = 70;
// Anchor scroll
$("a").each(function() {
if($(this).attr("href").substr(0, 1) === "#") {
$(this).on("click", function(e) {
e.preventDefault();
var id = $(this).attr("href");
$("html,body").animate({ scrollTop: parseInt($(id).offset().top) - headerSize }, 200);
window.location.hash = $(this).attr("href");
});
}
});
if(window.location.hash) {
var id = window.location.hash;
setTimeout(function() {
$("html,body").animate({ scrollTop: parseInt($(id).offset().top) - headerSize }, 0);
}, 1);
}
// Simple fix nav-main Scrollposition (no-resize)
var $doc = $(document);
var $nav = $(".nav-main");
var $params = $("#nav-main-params");
var maxMove = 270; // $params.offset().top - headerSize;
var height = $nav.height() - ($params.position().top - $nav.position().top) + headerSize;
function moveNav() {
if($doc.scrollTop() > maxMove) $nav.css({ marginTop: $doc.scrollTop() - maxMove });
else $nav.css({ marginTop: 0 });
}
// Enable if screen is heigh enough
if($doc.height() >= height) {
moveNav();
$doc.scroll(function() { moveNav(); });
}
});
</script>
</body>
</html>