• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2017 Google Inc.
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.google.doclava;
18 
19 public interface AuxSource {
classAuxTags(ClassInfo clazz)20   public TagInfo[] classAuxTags(ClassInfo clazz);
fieldAuxTags(FieldInfo field)21   public TagInfo[] fieldAuxTags(FieldInfo field);
methodAuxTags(MethodInfo method)22   public TagInfo[] methodAuxTags(MethodInfo method);
paramAuxTags(MethodInfo method, ParameterInfo param, String comment)23   public TagInfo[] paramAuxTags(MethodInfo method, ParameterInfo param, String comment);
returnAuxTags(MethodInfo method)24   public TagInfo[] returnAuxTags(MethodInfo method);
25 }
26 
27 class EmptyAuxSource implements AuxSource {
28   @Override
classAuxTags(ClassInfo clazz)29   public TagInfo[] classAuxTags(ClassInfo clazz) {
30     return TagInfo.EMPTY_ARRAY;
31   }
32 
33   @Override
fieldAuxTags(FieldInfo field)34   public TagInfo[] fieldAuxTags(FieldInfo field) {
35     return TagInfo.EMPTY_ARRAY;
36   }
37 
38   @Override
methodAuxTags(MethodInfo method)39   public TagInfo[] methodAuxTags(MethodInfo method) {
40     return TagInfo.EMPTY_ARRAY;
41   }
42 
43   @Override
paramAuxTags(MethodInfo method, ParameterInfo param, String comment)44   public TagInfo[] paramAuxTags(MethodInfo method, ParameterInfo param, String comment) {
45     return TagInfo.EMPTY_ARRAY;
46   }
47 
48   @Override
returnAuxTags(MethodInfo method)49   public TagInfo[] returnAuxTags(MethodInfo method) {
50     return TagInfo.EMPTY_ARRAY;
51   }
52 }
53