Code review request for javax.lang.model doclint cleanup

Joseph Darcy joe.darcy at oracle.com
Mon Jun 17 14:52:38 PDT 2013


Thanks for the review; changes pushed under

     8016779: Fix doclint warnings in javax.lang.model

-Joe

On 6/17/2013 9:34 AM, Jonathan Gibbons wrote:
> Looks good to me.  It'll be good to have langtools be doclint-clean.
>
> -- Jon
>
> On 06/15/2013 10:27 AM, Joe Darcy wrote:
>> Hello,
>>
>> Please review the patch below which resolves a few remaining doclint 
>> warnings on protected elements in the javax.lang.model API; with this 
>> change, API is now doclint clean :-)
>>
>> I'll file a bug after getting a review.
>>
>> Thanks,
>>
>> -Joe
>>
>> diff -r 1936a884b290 
>> src/share/classes/javax/lang/model/util/ElementScanner6.java
>> --- a/src/share/classes/javax/lang/model/util/ElementScanner6.java 
>> Fri Jun 14 18:01:52 2013 +0100
>> +++ b/src/share/classes/javax/lang/model/util/ElementScanner6.java 
>> Sat Jun 15 10:24:11 2013 -0700
>> @@ -110,6 +110,8 @@
>>      /**
>>       * Constructor for concrete subclasses; uses the argument for the
>>       * default value.
>> +     *
>> +     * @param defaultValue the default value
>>       */
>>      protected ElementScanner6(R defaultValue){
>>          DEFAULT_VALUE = defaultValue;
>> diff -r 1936a884b290 
>> src/share/classes/javax/lang/model/util/ElementScanner7.java
>> --- a/src/share/classes/javax/lang/model/util/ElementScanner7.java 
>> Fri Jun 14 18:01:52 2013 +0100
>> +++ b/src/share/classes/javax/lang/model/util/ElementScanner7.java 
>> Sat Jun 15 10:24:11 2013 -0700
>> @@ -1,5 +1,5 @@
>>  /*
>> - * Copyright (c) 2010, 2012, Oracle and/or its affiliates. All 
>> rights reserved.
>> + * Copyright (c) 2010, 2013, 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
>> @@ -101,6 +101,8 @@
>>      /**
>>       * Constructor for concrete subclasses; uses the argument for the
>>       * default value.
>> +     *
>> +     * @param defaultValue the default value
>>       */
>>      protected ElementScanner7(R defaultValue){
>>          super(defaultValue);
>> diff -r 1936a884b290 
>> src/share/classes/javax/lang/model/util/ElementScanner8.java
>> --- a/src/share/classes/javax/lang/model/util/ElementScanner8.java 
>> Fri Jun 14 18:01:52 2013 +0100
>> +++ b/src/share/classes/javax/lang/model/util/ElementScanner8.java 
>> Sat Jun 15 10:24:11 2013 -0700
>> @@ -1,5 +1,5 @@
>>  /*
>> - * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All 
>> rights reserved.
>> + * Copyright (c) 2011, 2013, 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
>> @@ -101,6 +101,8 @@
>>      /**
>>       * Constructor for concrete subclasses; uses the argument for the
>>       * default value.
>> +     *
>> +     * @param defaultValue the default value
>>       */
>>      protected ElementScanner8(R defaultValue){
>>          super(defaultValue);
>> diff -r 1936a884b290 
>> src/share/classes/javax/lang/model/util/SimpleTypeVisitor6.java
>> --- a/src/share/classes/javax/lang/model/util/SimpleTypeVisitor6.java 
>> Fri Jun 14 18:01:52 2013 +0100
>> +++ b/src/share/classes/javax/lang/model/util/SimpleTypeVisitor6.java 
>> Sat Jun 15 10:24:11 2013 -0700
>> @@ -118,6 +118,10 @@
>>       * The default action for visit methods.  The implementation in
>>       * this class just returns {@link #DEFAULT_VALUE}; subclasses will
>>       * commonly override this method.
>> +     *
>> +     * @param e the type to process
>> +     * @param p a visitor-specified parameter
>> +     * @return {@code DEFAULT_VALUE} unless overridden
>>       */
>>      protected R defaultAction(TypeMirror e, P p) {
>>          return DEFAULT_VALUE;
>>
>



More information about the compiler-dev mailing list