Skip to content

API Availability

Paul N Stickney edited this page Feb 3, 2020 · 1 revision

Type Availability

Only types and methods exported as part of the ::vt namespace are generally public API endpoints.

Types and methods in other namespaces do not constitute the public API and usage of such may lead to future code compatibility issues.

Some methods and/or types exposed part of ::vt (directly or indirectly) still may not be publicly accessible types. (TODO: Doxygen to clearly define internal and external API.)

Versioning

Only a major version release is expected to eliminate a previous public API entirely. The deprecated attribute is expected to be used, if applicable.

Minor releases may strengthen APIs, including restrictions to types or code which might have previously been allowed (although in a suspicious context).