[ 
https://issues.apache.org/jira/browse/GEODE-1783?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Kirk Lund updated GEODE-1783:
-----------------------------
    Description: 
The javadocs for com.gemstone.gemfire.distributed.ConfigurationProperties 
contains invalid javadoc syntax and typos.

The use of <p> and/or </p> (this varies from constant to constant) is 
inconsistent with 
http://www.oracle.com/technetwork/articles/java/index-137868.html.

There are spelling typos, such as "seperated".

The fix should include:

1) strict compliance with 
http://www.oracle.com/technetwork/articles/java/index-137868.html
2) consistent formatting for javadocs on all property constants
3) no misspelled words
4) javadocs should render properly in Eclipse, IntelliJ and in HTML generated 
by javadoc


  was:
The javadocs for com.gemstone.gemfire.distributed.ConfigurationProperties 
contains invalid javadoc syntax and typos.

The use of <p> and/or </p> (this varies from constant to constant) is 
inconsistent with 
http://www.oracle.com/technetwork/articles/java/index-137868.html.

There are spelling typos, such as "seperated".

The fix should include:

1) strict compliance with 
http://www.oracle.com/technetwork/articles/java/index-137868.html
2) consistent formatting for javadocs on all property constants
3) no misspelled words



> ConfigurationProperties javadocs contains invalid javadoc syntax and typos
> --------------------------------------------------------------------------
>
>                 Key: GEODE-1783
>                 URL: https://issues.apache.org/jira/browse/GEODE-1783
>             Project: Geode
>          Issue Type: Bug
>          Components: general
>            Reporter: Kirk Lund
>            Assignee: Kirk Lund
>
> The javadocs for com.gemstone.gemfire.distributed.ConfigurationProperties 
> contains invalid javadoc syntax and typos.
> The use of <p> and/or </p> (this varies from constant to constant) is 
> inconsistent with 
> http://www.oracle.com/technetwork/articles/java/index-137868.html.
> There are spelling typos, such as "seperated".
> The fix should include:
> 1) strict compliance with 
> http://www.oracle.com/technetwork/articles/java/index-137868.html
> 2) consistent formatting for javadocs on all property constants
> 3) no misspelled words
> 4) javadocs should render properly in Eclipse, IntelliJ and in HTML generated 
> by javadoc



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to