You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@geode.apache.org by "Karen Smoler Miller (JIRA)" <ji...@apache.org> on 2016/06/28 17:10:57 UTC

[jira] [Updated] (GEODE-1608) update javadocs given the new ConfigurationProperties interface

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

Karen Smoler Miller updated GEODE-1608:
---------------------------------------
    Description: 
With the new {{ConfigurationProperties}} interface, any/all javadocs that contain example code that uses a string literal for one of the defined properties, instead of its new static String definition should be changed.

For example, Example 3 of the javadocs for `CacheFactory`:
{code:java}
Cache c = new CacheFactory()
    .set("cache-xml-file", "myCache.xml")
    .create();
Region r = c.getRegion("myRegion");
{code}

should be changed to:
{code:java}
Cache c = new CacheFactory()
    .set(CACHE_XML_FILE, "myCache.xml")
    .create();
Region r = c.getRegion("myRegion");
{code}

  was:
With the new `ConfigurationProperties` interface, any/all javadocs that contain example code that uses a string literal for one of the defined properties, instead of its new static String definition should be changed.

For example, Example 3 of the javadocs for `CacheFactory`:
{{
Cache c = new CacheFactory()
    .set("cache-xml-file", "myCache.xml")
    .create();
  Region r = c.getRegion("myRegion");
}}

should be changed to:
{{
Cache c = new CacheFactory()
    .set(CACHE_XML_FILE, "myCache.xml")
    .create();
  Region r = c.getRegion("myRegion");
}}


> update javadocs given the new ConfigurationProperties interface
> ---------------------------------------------------------------
>
>                 Key: GEODE-1608
>                 URL: https://issues.apache.org/jira/browse/GEODE-1608
>             Project: Geode
>          Issue Type: Bug
>            Reporter: Karen Smoler Miller
>
> With the new {{ConfigurationProperties}} interface, any/all javadocs that contain example code that uses a string literal for one of the defined properties, instead of its new static String definition should be changed.
> For example, Example 3 of the javadocs for `CacheFactory`:
> {code:java}
> Cache c = new CacheFactory()
>     .set("cache-xml-file", "myCache.xml")
>     .create();
> Region r = c.getRegion("myRegion");
> {code}
> should be changed to:
> {code:java}
> Cache c = new CacheFactory()
>     .set(CACHE_XML_FILE, "myCache.xml")
>     .create();
> Region r = c.getRegion("myRegion");
> {code}



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