Skip to content

Commit d476ac3

Browse files
committed
fix javadoc formatting
1 parent 497b1d4 commit d476ac3

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

src/main/java/com/dtolabs/rundeck/plugin/resources/ec2/EC2ResourceModelSource.java

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,18 @@
4949
import static com.dtolabs.rundeck.plugin.resources.ec2.EC2ResourceModelSourceFactory.SYNCHRONOUS_LOAD;
5050

5151
/**
52+
* <p>
5253
* EC2ResourceModelSource produces nodes by querying the AWS EC2 API to list instances.
53-
* <p/>
54+
* </p>
55+
* <p>
5456
* The RunDeck node definitions are created from the instances on a mapping system to convert properties of the amazon
5557
* instances to attributes defined on the nodes.
56-
* <p/>
58+
* </p>
59+
* <p>
5760
* The EC2 requests are performed asynchronously, so the first request to {@link #getNodes()} will return null, and
5861
* subsequent requests may return the data when it's available.
59-
*
60-
* @author Greg Schueler <a href="mailto:greg@dtosolutions.com">greg@dtosolutions.com</a>
62+
* </p>
63+
* @author Greg Schueler <a href="mailto:greg@rundeck.com">greg@rundeck.com</a>
6164
*/
6265
public class EC2ResourceModelSource implements ResourceModelSource {
6366
static Logger logger = LoggerFactory.getLogger(EC2ResourceModelSource.class);

src/main/java/com/dtolabs/rundeck/plugin/resources/ec2/EC2ResourceModelSourceFactory.java

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,21 @@
3535
import java.util.*;
3636

3737
/**
38-
* EC2ResourceModelSourceFactory is the factory that can create a {@link ResourceModelSource} based on a configuration.
39-
* <p/>
40-
* The configuration properties are: <ul> <li>endpoint: the AWS endpoint to use, or blank for the default (us-east-1)</li>
41-
* <li>filter: A set of ";" separated query filters ("filter=value") for the AWS EC2 API, see <a
42-
* href="http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeInstances.html">DescribeInstances</a></li>
43-
* <li>mappingParams: A set of ";" separated mapping entries</li> <li>runningOnly: if "true", automatically filter the
44-
* instances by "instance-state-name=running"</li> <li>accessKey: API AccessKey value</li> <li>secretKey: API SecretKey
45-
* value</li> <li>mappingFile: Path to a java properties-formatted mapping definition file.</li> <li>refreshInterval:
46-
* Time in seconds used as minimum interval between calls to the AWS API.</li> <li>useDefaultMapping: if "true", base
47-
* all mapping definitions off the default mapping provided. </li> </ul>
48-
*
49-
* @author Greg Schueler <a href="mailto:[email protected]">[email protected]</a>
38+
* <p>EC2ResourceModelSourceFactory is the factory that can create a {@link ResourceModelSource} based on a configuration.</p>
39+
* <p>The configuration properties are:</p>
40+
* <ul>
41+
* <li>endpoint: the AWS endpoint to use, or blank for the default (us-east-1)</li>
42+
* <li>filter: A set of ";" separated query filters ("filter=value") for the AWS EC2 API, see
43+
* <a href="http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeInstances.html">DescribeInstances</a></li>
44+
* <li>mappingParams: A set of ";" separated mapping entries</li>
45+
* <li>runningOnly: if "true", automatically filter the instances by "instance-state-name=running"</li>
46+
* <li>accessKey: API AccessKey value</li>
47+
* <li>secretKey: API SecretKey value</li>
48+
* <li>mappingFile: Path to a java properties-formatted mapping definition file.</li>
49+
* <li>refreshInterval: Time in seconds used as minimum interval between calls to the AWS API.</li>
50+
* <li>useDefaultMapping: if "true", base all mapping definitions off the default mapping provided.</li>
51+
* </ul>
52+
* @author Greg Schueler <a href="mailto:[email protected]">[email protected]</a>
5053
*/
5154
@Plugin(name = "aws-ec2", service = "ResourceModelSource")
5255
public class EC2ResourceModelSourceFactory implements ResourceModelSourceFactory, Describable {

0 commit comments

Comments
 (0)