• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.googlecode.android_scripting.rpc;
18 
19 import java.lang.annotation.Documented;
20 import java.lang.annotation.ElementType;
21 import java.lang.annotation.Retention;
22 import java.lang.annotation.RetentionPolicy;
23 import java.lang.annotation.Target;
24 
25 /**
26  * An annotation that is used to document the parameters of an RPC.
27  */
28 @Retention(RetentionPolicy.RUNTIME)
29 @Target(ElementType.PARAMETER)
30 @Documented
31 public @interface RpcParameter {
32     /**
33      * The name of the formal parameter. This should be in agreement with the java code.
34      */
name()35     String name();
36 
37     /**
38      * Description of the RPC. This should be a short descriptive statement without a full stop, such
39      * as 'disables the WiFi mode'.
40      */
description()41     String description() default "";
42 }
43