1 /*
   2  * Copyright (c) 2003, 2015, 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.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 /*
  25  * @test
  26  * @bug      4934778 4777599 6553182
  27  * @summary  Make sure that the -help option works properly.  Make sure
  28  *           the help link appears in the documentation.
  29  * @author   jamieh
  30  * @library ../lib
  31  * @modules jdk.javadoc
  32  * @build    JavadocTester TestHelpOption
  33  * @run main TestHelpOption
  34  */
  35 
  36 public class TestHelpOption extends JavadocTester {
  37 
  38     public static void main(String... args) throws Exception {
  39         TestHelpOption tester = new TestHelpOption();
  40         tester.runTests();
  41     }
  42 
  43     @Test
  44     void testWithOption() {
  45         javadoc("-d", "out1",
  46                 "-sourcepath", testSrc,
  47                 "-help",
  48                 testSrc("TestHelpOption.java"));
  49         checkExit(Exit.OK);
  50 
  51         checkOutput(true);
  52     }
  53 
  54     @Test
  55     void testWithoutOption() {
  56         javadoc("-d", "out2",
  57                 "-sourcepath", testSrc,
  58                 testSrc("TestHelpOption.java"));
  59         checkExit(Exit.OK);
  60 
  61         checkOutput(false);
  62     }
  63 
  64     private void checkOutput(boolean withOption) {
  65         checkOutput(Output.STDOUT, withOption,
  66                 "-d ",
  67                 "-use ",
  68                 "-version ",
  69                 "-author ",
  70                 "-docfilessubdirs ",
  71                 "-splitindex ",
  72                 "-windowtitle ",
  73                 "-doctitle ",
  74                 "-header ",
  75                 "-footer ",
  76                 "-bottom ",
  77                 "-link ",
  78                 "-linkoffline ",
  79                 "-excludedocfilessubdir ",
  80                 "-group ",
  81                 "-nocomment ",
  82                 "-nodeprecated ",
  83                 "-noqualifier ",
  84                 "-nosince ",
  85                 "-notimestamp ",
  86                 "-nodeprecatedlist ",
  87                 "-notree ",
  88                 "-noindex ",
  89                 "-nohelp ",
  90                 "-nonavbar ",
  91                 "-serialwarn ",
  92                 "-tag ",
  93                 "-taglet ",
  94                 "-tagletpath ",
  95                 "-charset ",
  96                 "-helpfile ",
  97                 "-linksource ",
  98                 "-sourcetab ",
  99                 "-keywords ",
 100                 "-stylesheetfile ",
 101                 "-docencoding ");
 102 
 103         checkOutput("TestHelpOption.html", !withOption,
 104                 "<li><a href=\"help-doc.html\">Help</a></li>");
 105     }
 106 }