Difference between revisions of "API Template"

Latest revision as of 06:38, 19 November 2017

== Usage ==
blah
=== Examples ===
blah


== Inheritance ==
blah
=== Base classes ===
*list
**deeper list
***even deeper
=== Derived classes ===
*list


== Reference ==
=== Constants ===
*list
=== Fields ===
*list
=== Constructors ===
*list
=== Accessors ===
*list
=== Methods ===
*list
=== Operators ===
*list

{{ge}}

Usage

Describe purpose and uses of the class

Examples

Optional: write a few examples of typical usage.

Inheritance

List a hierarchy of inheritance here

Base classes

• geObject
  • geResource
    • geTheClassDescribedOnThisPage

Derived classes

• geDerivedClass

Reference

All class features that are designated as public and protected should be listed here. Make sure to distinguish static fields and methods as such.

Constants

• List of constants, including #define's in the header, and typedef's

Fields

• List of fields (aka properties, aka attributes).

Constructors

• List of constructors

Accessors

• List of getters and setters

Methods

• List of methods that do not fit other categories

Operators

• List of overridden operators