1 /* 2 * Copyright (C) 2016 Google Inc. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 * use this file except in compliance with the License. You may obtain a copy of 6 * 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, WITHOUT 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 * License for the specific language governing permissions and limitations under 14 * 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 * @author Felix Arends (felix.arends@gmail.com) 29 * 30 */ 31 @Retention(RetentionPolicy.RUNTIME) 32 @Target(ElementType.PARAMETER) 33 @Documented 34 public @interface RpcParameter { 35 /** 36 * The name of the formal parameter. This should be in agreement with the java code. 37 */ name()38 public String name(); 39 40 /** 41 * Description of the RPC. This should be a short descriptive statement without a full stop, such 42 * as 'disables the WiFi mode'. 43 */ description()44 public String description() default ""; 45 } 46