forked from v2ray/v2ray-core
-
Notifications
You must be signed in to change notification settings - Fork 0
/
annotations.go
14 lines (13 loc) · 680 Bytes
/
annotations.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
package core
// Annotation is a concept in V2Ray. This struct is only for documentation. It is not used anywhere.
// Annotations begin with "v2ray:" in comment, as metadata of functions or types.
type Annotation struct {
// API is for types or functions that can be used in other libs. Possible values are:
//
// * v2ray:api:beta for types or functions that are ready for use, but maybe changed in the future.
// * v2ray:api:stable for types or functions with guarantee of backward compatibility.
// * v2ray:api:deprecated for types or functions that should not be used anymore.
//
// Types or functions without api annotation should not be used externally.
API string
}