1 /*

     2  * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 /*

    27  * @test

    28  * @bug      8173425

    29  * @summary  tests for the summary tag behavior

    30  * @library  ../lib

    31  * @modules jdk.javadoc/jdk.javadoc.internal.tool

    32  * @build    JavadocTester

    33  * @run main TestSummaryTag

    34  */

    35 

    36 public class TestSummaryTag extends JavadocTester {

    37 

    38     public static void main(String... args) throws Exception {

    39         TestSummaryTag tester = new TestSummaryTag();

    40         tester.runTests();

    41     }

    42 

    43     @Test

    44     void test1() {

    45         javadoc("-d", "out1",

    46                 "-sourcepath", testSrc,

    47                 "p1");

    48         checkExit(Exit.OK);

    49 

    50         checkOutput("index-all.html", true,

    51             "<dl>\n"

    52             + "<dt><span class=\"memberNameLink\"><a href=\"p1/A.html#m--\">m()"

    53             + "</a></span> - Method in class p1.<a href=\"p1/A.html\" title=\"class in p1\">A</a></dt>\n"

    54             + "<dd>\n"

    55             + "<div class=\"block\">First sentence</div>\n"

    56             + "</dd>\n"

    57             + "<dt><span class=\"memberNameLink\"><a href=\"p1/B.html#m--\">m()"

    58             + "</a></span> - Method in class p1.<a href=\"p1/B.html\" title=\"class in p1\">B</a></dt>\n"

    59             + "<dd>\n"

    60             + "<div class=\"block\">First sentence</div>\n"

    61             + "</dd>\n"

    62             + "<dt><span class=\"memberNameLink\"><a href=\"p1/A.html#m1--\">m1()"

    63             + "</a></span> - Method in class p1.<a href=\"p1/A.html\" title=\"class in p1\">A</a></dt>\n"

    64             + "<dd>\n"

    65             + "<div class=\"block\"> First sentence </div>\n"

    66             + "</dd>\n"

    67             + "<dt><span class=\"memberNameLink\"><a href=\"p1/A.html#m2--\">m2()"

    68             + "</a></span> - Method in class p1.<a href=\"p1/A.html\" title=\"class in p1\">A</a></dt>\n"

    69             + "<dd>\n"

    70             + "<div class=\"block\">Some html &lt;foo&gt; &nbsp; codes</div>\n"

    71             + "</dd>\n"

    72             + "<dt><span class=\"memberNameLink\"><a href=\"p1/A.html#m3--\">m3()"

    73             + "</a></span> - Method in class p1.<a href=\"p1/A.html\" title=\"class in p1\">A</a></dt>\n"

    74             + "<dd>\n"

    75             + "<div class=\"block\">First sentence </div>\n"

    76             + "</dd>\n"

    77             + "<dt><span class=\"memberNameLink\"><a href=\"p1/A.html#m4--\">m4()"

    78             + "</a></span> - Method in class p1.<a href=\"p1/A.html\" title=\"class in p1\">A</a></dt>\n"

    79             + "<dd>\n"

    80             + "<div class=\"block\">First sentence i.e. the first sentence</div>\n"

    81             + "</dd>\n"

    82             + "</dl>\n",

    83             "<div class=\"block\">The first... line</div>\n"

    84         );

    85 

    86         // make sure the second @summary's content is displayed correctly

    87         checkOutput("p1/A.html", true,

    88              "<li class=\"blockList\">\n"

    89              + "<h4>m3</h4>\n"

    90              + "<pre>public&nbsp;void&nbsp;m3&#8203;()</pre>\n"

    91              + "<div class=\"block\">First sentence  some text maybe second sentence.</div>\n"

    92              + "</li>\n"

    93         );

    94 

    95         checkOutput("p1/package-summary.html", true,

    96                 "<div class=\"block\">The first... line second from ...</div>");

    97     }

    98     @Test

    99     void test2() {

   100         javadoc("-d", "out2",

   101                 "-sourcepath", testSrc,

   102                 "p2");

   103         checkExit(Exit.OK);

   104 

   105         checkOutput(Output.OUT, true, "package.html:5: warning: invalid use of @summary");

   106 

   107         checkOutput("index-all.html", true, "<div class=\"block\">foo bar</div>\n");

   108 

   109         checkOutput("p2/package-summary.html", true, "<div class=\"block\">foo bar baz.</div>\n");

   110     }

   111 

   112     @Test

   113     void test3() {

   114         javadoc("-d", "out3",

   115                 "-sourcepath", testSrc,

   116                 "-overview", testSrc("p3/overview.html"),

   117                 "p3");

   118         checkExit(Exit.OK);

   119 

   120         checkOutput("overview-summary.html", true,

   121                 "<div class=\"block\">The first... line second from ...</div>");

   122     }

   123 }