Template:API Link

From FlightGear wiki
Jump to navigation Jump to search


The following template description is not displayed when the template is inserted in an article.

Goal

This template is used when linking to FlightGear API documentation which is generated by Doxygen.

Note This template will add an external link. You will therefore have to answer a security question before your edit is saved

Usage

{{API Link|category|type|name}}

All parameters are mandatory.

category
The code base that the API is in. Must be one of fgdata, flightgear, simgear, osg, plib, terragear, or fgms.
type
Type of API, for example class.
name
Name of the API.

Examples

{{API Link|flightgear|class|FGNasalSys}}

FGNasalSys (doxygen)

{{API Link|simgear|class|SGBinObject}}

SGBinObject (doxygen)

{{API Link|osg|class|GifImageStream}}

GifImageStream (doxygen)


flightgear_1_1CameraGroup (doxygen)