test/tools/javadoc/InlineTagsWithBraces.java

Wed, 14 Nov 2018 10:18:25 -0800

author
diazhou
date
Wed, 14 Nov 2018 10:18:25 -0800
changeset 3762
7909abb85562
parent 554
9d9f26857129
child 2525
2eb010b6cb22
permissions
-rw-r--r--

Added tag jdk8u201-b04 for changeset a7f48b9dfb82

duke@1 1 /*
ohair@554 2 * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation.
duke@1 8 *
duke@1 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 13 * accompanied this code).
duke@1 14 *
duke@1 15 * You should have received a copy of the GNU General Public License version
duke@1 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 18 *
ohair@554 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 20 * or visit www.oracle.com if you need additional information or have any
ohair@554 21 * questions.
duke@1 22 */
duke@1 23
duke@1 24 /*
duke@1 25 * @test
duke@1 26 * @bug 4965490
duke@1 27 * @summary Verify that matching braces can appear within inline tags.
duke@1 28 */
duke@1 29
duke@1 30 import com.sun.javadoc.*;
duke@1 31
duke@1 32 /**
duke@1 33 * This is a {@code test} comment.
duke@1 34 * It is {@bold {@underline only} a test}.
duke@1 35 * We would like some code
duke@1 36 * {@code for (int i : nums) { doit(i); } return; }
duke@1 37 * to be embedded {@maybe {even {a couple {of levels}}} deep}.
duke@1 38 */
duke@1 39 public class InlineTagsWithBraces extends Doclet {
duke@1 40
duke@1 41 private static String[] expectedTags = {
duke@1 42 "Text", "@code", "Text",
duke@1 43 "@bold", "Text", "@code", "Text",
duke@1 44 "@maybe", "Text"
duke@1 45 };
duke@1 46 private static String[] expectedText = {
duke@1 47 "This is a ", "test", " comment.\n" +
duke@1 48 " It is ", "{@underline only} a test", ".\n" +
duke@1 49 " We would like some code\n" +
duke@1 50 " ", "for (int i : nums) { doit(i); } return; ", "\n" +
duke@1 51 " to be embedded ", "{even {a couple {of levels}}} deep", "."
duke@1 52 };
duke@1 53
duke@1 54
duke@1 55 public static void main(String[] args) {
duke@1 56 String thisFile = "" +
duke@1 57 new java.io.File(System.getProperty("test.src", "."),
duke@1 58 "InlineTagsWithBraces.java");
duke@1 59
duke@1 60 if (com.sun.tools.javadoc.Main.execute(
duke@1 61 "javadoc",
duke@1 62 "InlineTagsWithBraces",
jjg@140 63 InlineTagsWithBraces.class.getClassLoader(),
duke@1 64 new String[] {"-Xwerror", thisFile}) != 0)
duke@1 65 throw new Error("Javadoc encountered warnings or errors.");
duke@1 66 }
duke@1 67
duke@1 68 public static boolean start(RootDoc root) {
duke@1 69 ClassDoc cd = root.classes()[0];
duke@1 70 Tag[] tags = cd.inlineTags();
duke@1 71
duke@1 72 for (int i = 0; i < tags.length; i++) {
duke@1 73 if (!tags[i].name().equals(expectedTags[i]) ||
duke@1 74 !tags[i].text().equals(expectedText[i])) {
duke@1 75 throw new Error("Tag \"" + tags[i] + "\" not as expected");
duke@1 76 }
duke@1 77 }
duke@1 78
duke@1 79 return true;
duke@1 80 }
duke@1 81 }

mercurial