github.com/xraypb/Xray-core@v1.8.1/core/annotations.go (about)

     1  package core
     2  
     3  // Annotation is a concept in Xray. This struct is only for documentation. It is not used anywhere.
     4  // Annotations begin with "xray:" in comment, as metadata of functions or types.
     5  type Annotation struct {
     6  	// API is for types or functions that can be used in other libs. Possible values are:
     7  	//
     8  	// * xray:api:beta for types or functions that are ready for use, but maybe changed in the future.
     9  	// * xray:api:stable for types or functions with guarantee of backward compatibility.
    10  	// * xray:api:deprecated for types or functions that should not be used anymore.
    11  	//
    12  	// Types or functions without api annotation should not be used externally.
    13  	API string
    14  }