geode-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Bruce Schuchardt (JIRA)" <j...@apache.org>
Subject [jira] [Created] (GEODE-1815) ConfigurationProperties javadocs need to be more descriptive in a number of cases
Date Wed, 24 Aug 2016 22:24:20 GMT
Bruce Schuchardt created GEODE-1815:
---------------------------------------

             Summary: ConfigurationProperties javadocs need to be more descriptive in a number
of cases
                 Key: GEODE-1815
                 URL: https://issues.apache.org/jira/browse/GEODE-1815
             Project: Geode
          Issue Type: Bug
          Components: security
            Reporter: Bruce Schuchardt


There are a number of new SECURITY properties in ConfigurationProperties that have a "geode
1.0" tag that have inadequate javadocs.  This is the primary location for documenting distribution
config properties, so they need to have a good description like all of the other properties.

This is one such property:

{noformat}
  @Override
  public Properties getDistributedSystemProperties() {
    Properties result = super.getDistributedSystemProperties();
    result.put(ConfigurationProperties.ENABLE_NETWORK_PARTITION_DETECTION, "false");
    return result;
  }
{noformat}

this is a properly documented property:

{noformat}
  /**
   * The static String definition of the <i>"remote-locators"</i> property
   * <a name="remote-locators"/a><p>
   * <U>Description</U>: A list of locators (host and port) that a cluster
   * will use in order to connect to a remote site in a multi-site (WAN)
   * configuration. This attribute's value is a possibly comma separated list.
   * <p>For each remote locator, provide a hostname and/or address
   * (separated by '@', if you use both), followed by a port number in brackets.
   * <p>Examples:
   * remote-locators=address1[port1],address2[port2]
   * <p>
   * remote-locators=hostName1@address1[port1],hostName2@address2[port2]
   * <p>
   * remote-locators=hostName1[port1],hostName2[port2]<p>
   * <p>
   * <U>Default</U>: ""
   */
  String REMOTE_LOCATORS = "remote-locators";
{noformat}



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

Mime
View raw message