changeset 3567:0f8b6aba6279

8075529: Documentation in DocumentationTool.getTask(...) should mention about "null" parameter for doclet. Reviewed-by: jjg
author ksrini
date Tue, 09 Aug 2016 07:31:16 -0700
parents aebfafc43714
children d7aa2b610144
files src/java.compiler/share/classes/javax/tools/DocumentationTool.java
diffstat 1 files changed, 2 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/src/java.compiler/share/classes/javax/tools/DocumentationTool.java	Mon Aug 08 11:48:02 2016 -0700
+++ b/src/java.compiler/share/classes/javax/tools/DocumentationTool.java	Tue Aug 09 07:31:16 2016 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2016, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -57,7 +57,7 @@
      * use the tool's default method for reporting diagnostics
      *
      * @param docletClass a class providing the necessary methods required
-     * of a doclet
+     * of a doclet; a value of {@code null} means to use the standard doclet.
      *
      * @param options documentation tool options and doclet options,
      * {@code null} means no options