Funktionsreferenzen (funcsynopsis)
(Auszug aus "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" von Thomas Schraitle)
Meist sollen in Referenzseiten nicht nur Befehle, sondern auch Funktionen beschrieben werden. Hierfür steht das Element funcsynopsis bereit. Betrachten Sie die folgende Phantasiefunktion im nachstehenden Beispiel:
Beispiel: Aufbau einer Funktionsreferenz (funcsynopsis.xml)
<funcsynopsis>
<funcprototype>
<?dbhtml funcsynopsis-style="..."?>
<funcdef>int <function>foo</function></funcdef>
<paramdef>char *<parameter>src</parameter>[]</paramdef>
<paramdef>int <parameter>val</parameter></paramdef>
</funcprototype>
</funcsynopsis>Zeile 2: Der Funktionsprototyp beginnt mit dem Element funcprototype.
Zeile 3: Verarbeitungsanweisung für den Ausgabestil; für C++ ist dies entweder kr (von Kerningham and Richie) oder ansi (siehe untere Ausgabe).
Zeile 4: Der Rückgabewert der Funktion wird direkt eingegeben, der Funktionsname über function.
Zeile 5: Die jeweiligen Parameter der Funktion werden mit dem Element paramdef markiert. Der Typ wird direkt eingefügt, der Parametername mit parameter.
Die möglichen Stilrichtungen sind wie folgt dargestellt:
| K&R-Stil | ANSI-Stil |
| int foo (src, val); char *src [ ]; int val; | int foo (char *src [ ], int val ); |
Weitere Beispiele finden sich im TDG unter dem Stichwort funcprototype.
| << zurück | vor >> |
Copyright © 2009 Millin Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.
Millin Verlag, Siebengebirgsring 36, 53797 Lohmar, info(at)millin.de