Module com.ensarsarajcic.neovim.java.neovimapi

Package com.ensarsarajcic.neovim.java.api

Annotation Interface NeovimApiFunction

@Target(METHOD)
@Retention(RUNTIME)
@Documented
@Inherited
public @interface NeovimApiFunction

Annotation marking that method is a NeovimApiFunction Marking with this annotation means that the method will do the actual call

It is useful for documentation since it contains information about versions, params and name It could also be used for generating clients and for compile time checking

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
int	deprecatedIn	Version of NeovimApis API the function/method was deprecated in It is used for documentation It can also be used for checking if method is supported by current version 0 means it is not deprecated
String	name	Name of the function/method This is the name used to call the function via RPC
int	since	Version of NeovimApis API the function/method was introduced in It is used for documentation It can also be used for checking if method is supported by current version
String	useFunction	If function/method is deprecated, this can be used to point to function that should be used instead

Element Details

name

String name

Name of the function/method This is the name used to call the function via RPC

Default:

""

since

int since

Version of NeovimApis API the function/method was introduced in It is used for documentation It can also be used for checking if method is supported by current version

Default:

0

deprecatedIn

int deprecatedIn

Version of NeovimApis API the function/method was deprecated in It is used for documentation It can also be used for checking if method is supported by current version 0 means it is not deprecated

Default:

0

useFunction

String useFunction

If function/method is deprecated, this can be used to point to function that should be used instead

Default:

""