API-Dokumentation

Die Mapbender3 API Dokumentation findet sich unter http://api.mapbender3.org/.

Wie wird die Mapbender3 API Dokumentation erstellt?

PHP

ApiGen - wird verwendet, um die API-Dokumentation zu generieren. Sie müssen nur docblocks in den Code einfügen. Ein Beispiel für eine Klasse mit docblock-Kommentaren:

 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
<?php

/**
 * License Block - Todo
 */

namespace Mapbender;

use Mapbender\Component\Foo;

/**
 * Just an API-doc example (Oneline description used in lists)
 *
 * Bar is just an API documentation example to serve as a guideline,
 * inspiration and to be included in the developer's book.
 *
 * This file is directly included in the documentation. Yeah!
 *
 * @todo Make me better
 *
 * @author Christian Wygoda <christian.wygoda@wheregroup.com>
 */
class Example extends Foo
{
    /**
     * Constructor
     *
     * Does some magic.
     */
    public function __construct()
    {
    }

    /**
     * Magic function
     *
     * Does some pretty awesome magic.
     *
     * @param array $input input data
     * @return string Result string
     *
     * @deprecated use newMagic instead
     */
    public function oldMagic(array $input)
    {
    }

    /**
     * Magic function
     *
     * Does some pretty awesome magic, only better.
     *
     * @param array $input input data
     * @return string Result string
     *
     * @todo make faster
     */
    public function newMagic(array $input)
    {
    }
}

Schauen Sie sich die Dokumentationsblöcke in der Example.php an.

JavaScript

Bisher wurden keine guten Tools gefunden.

Table Of Contents

Previous topic

Elemente verstehen

Next topic

Elemente verstehen

This Page