lzhr/v2fly
1
0
Fork 0
mirror of https://github.com/v2fly/v2ray-core.git synced 2025-12-26 12:05:35 -05:00
Code Issues Releases Wiki Activity

API doc

Browse Source
This commit is contained in:
Darien Raymond
2018-12-03 22:44:42 +01:00
parent 05f8de1b8f
commit 28fa84ce69
11 changed files with 60 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
annotations.go Normal file
View File

@@ -0,0 +1,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
}