1 /* 2 * Copyright (C) 2022 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.example.classes; 18 19 public class Tags { 20 21 /** 22 * @see PublicClass 23 * @see PublicAnnotation with comments 24 * @see <a href="https://example.com">html link</a> 25 */ 26 public static class See { 27 28 } 29 30 /** 31 * @throws IllegalArgumentException 32 * @throws IllegalArgumentException with some comments 33 */ 34 public static class Throws { 35 36 } 37 38 /** 39 * First sentence of the class that consists of three tags: text, inline ({@code something}) 40 * and text. Then goes the second sentence of class javadoc. It is followed by a third 41 * sentence that has some inline tags, such as {@code some code}, 42 * {@link java.lang.Integer label} and {@linkplain java.lang.Byte label}. 43 * 44 * @author someone with a very long name 45 * @version version 46 * @see Throws 47 * @since 1.0 48 */ 49 public static class Various { 50 51 /** 52 * @serial field description 53 * @see #method(String) for details 54 */ 55 private int serial; 56 57 /** 58 * First sentence of method javadoc. Then goes the second sentence which contains some 59 * inline tags, such as {@code code block} and {@link #serial label}. 60 * 61 * @exception IllegalArgumentException iae desc 62 * @throws NullPointerException npe desc 63 * @param x description of param named x 64 * @return number, always zero 65 * @see Integer 66 * @since 1.1 67 */ method(String x)68 public Integer method(String x) throws Exception { 69 return 0; 70 } 71 72 /** 73 * This method is marked as deprecated in javadoc with a tag. 74 * 75 * @deprecated 76 */ deprecatedMethod()77 public void deprecatedMethod() { 78 79 } 80 81 } 82 83 /** 84 * Fixture to test {@link com.google.doclava.javadoc.ParamTagImpl}. 85 * 86 * @param <T> stored in Box 87 */ 88 public static class Box<T> { 89 private T storedObject; 90 private int price; 91 Box()92 private Box() {} 93 94 /** 95 * @param storedObject Something valuable 96 * @param price 97 */ Box(T storedObject, int price)98 public Box(T storedObject, int price) { 99 this.storedObject = storedObject; 100 this.price = price; 101 } 102 value()103 public T value() { 104 return storedObject; 105 } 106 } 107 108 /** 109 * @see 110 */ 111 public class Malformed { 112 113 } 114 } 115