Typo in AbstractMemberWriter.addModifiers(Element member, Content htmltree) doc

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Typo in AbstractMemberWriter.addModifiers(Element member, Content htmltree) doc

Christoph Dreis

Hi,

 

Just noticed a small typo in the @param doc for AbstractMemberWriter.addModifiers(Element member, Content htmltree).

 

Would be happy if this is sponsored.

 

Cheers,

Christoph

 

==== PATCH ====

diff -r 359c604930af src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java

--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java Fri Oct 27 09:51:48 2017 -0700

+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java Sun Oct 29 15:56:32 2017 +0100

@@ -229,7 +229,7 @@

      * Add the modifier for the member. The modifiers are ordered as specified

      * by <em>The Java Language Specification</em>.

      *

-     * @param member the member for which teh modifier will be added.

+     * @param member the member for which the modifier will be added.

      * @param htmltree the content tree to which the modifier information will be added.

      */

     protected void addModifiers(Element member, Content htmltree) {

 

 

 

Reply | Threaded
Open this post in threaded view
|

Re: Typo in AbstractMemberWriter.addModifiers(Element member, Content htmltree) doc

Jonathan Gibbons
Christoph,

Thanks for pointing this out.

Since this is "just" a minor typo in the doc comment for an internal API, it does not seem worth sponsoring
this as a patch in its own right.  We already have some work in progress on that file currently being reviewed;
I'll fix the typo as part of that, if that's OK with you.

-- Jon


On 10/29/2017 08:04 AM, Christoph Dreis wrote:

Hi,

 

Just noticed a small typo in the @param doc for AbstractMemberWriter.addModifiers(Element member, Content htmltree).

 

Would be happy if this is sponsored.

 

Cheers,

Christoph

 

==== PATCH ====

diff -r 359c604930af src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java

--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java Fri Oct 27 09:51:48 2017 -0700

+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java Sun Oct 29 15:56:32 2017 +0100

@@ -229,7 +229,7 @@

      * Add the modifier for the member. The modifiers are ordered as specified

      * by <em>The Java Language Specification</em>.

      *

-     * @param member the member for which teh modifier will be added.

+     * @param member the member for which the modifier will be added.

      * @param htmltree the content tree to which the modifier information will be added.

      */

     protected void addModifiers(Element member, Content htmltree) {

 

 

 


Reply | Threaded
Open this post in threaded view
|

RE: Typo in AbstractMemberWriter.addModifiers(Element member, Content htmltree) doc

Christoph Dreis
Hi Jon,

> Since this is "just" a minor typo in the doc comment for an internal API,
it does not seem worth sponsoring
> this as a patch in its own right.  We already have some work in progress
on that file currently being reviewed;
> I'll fix the typo as part of that, if that's OK with you.

Thanks. I don't mind.

Cheers,
Christoph