Permalink
Browse files

Fix javadoc comments.

  • Loading branch information...
1 parent fa6ea73 commit e6e92c9d41818681a01f709e33e0f22f35005cac Karthik Ranganathan committed Aug 27, 2012
@@ -101,7 +101,9 @@ public Builder addMetadata(MetaDataKey key, String value) {
}
/**
- * Build the {@link InstanceInfo}
+ * Build the {@link InstanceInfo} information.
+ *
+ * @return AWS specific instance information.
*/
public AmazonInfo build() {
return result;
@@ -115,9 +115,11 @@ public InstanceInfo getInfo() {
}
/**
- * Register user-specific instance metadata. Application can send any other
- * additional metadata that need to be accessed for other reasons.The data
+ * Register user-specific instance meta data. Application can send any other
+ * additional meta data that need to be accessed for other reasons.The data
* will be periodically sent to the eureka server.
+ *
+ * @param appMetadata application specific meta data.
*/
public void registerAppMetadata(Map<String, String> appMetadata) {
instanceInfo.registerRuntimeMetadata(appMetadata);
@@ -17,6 +17,8 @@
import java.util.Map;
+import com.netflix.discovery.DiscoveryClient;
+
/**
* Configuration information required by the instance to register with Eureka
* server. Once registered, users can look up information from
@@ -26,8 +28,8 @@
*
*
* <p>
- * Note that all configurations are not effective at runtime unless
- * and otherwise specified.
+ * Note that all configurations are not effective at runtime unless and
+ * otherwise specified.
* </p>
*
* @author Karthik Ranganathan
@@ -93,7 +95,7 @@
*
* <p>
* Note that the instance could still not take traffic if it implements
- * {@link HealhCheckCallback} and then decides to make itself unavailable.
+ * {@link HealthCheckCallback} and then decides to make itself unavailable.
* </p>
*
* @return time in seconds
@@ -114,7 +116,7 @@
* .
* </p>
*
- * @return
+ * @return value indicating time in seconds.
*/
int getLeaseExpirationDurationInSeconds();
@@ -128,7 +130,8 @@
* this instance.
* </p>
*
- * @return
+ * @return the string indicating the virtual host name which the clients use
+ * to call this service.
*/
String getVirtualHostName();
@@ -142,7 +145,8 @@
* this instance.
* </p>
*
- * @return
+ * @return the string indicating the secure virtual host name which the clients use
+ * to call this service.
*/
String getSecureVirtualHostName();
@@ -160,7 +164,9 @@
* Gets the hostname associated with this instance. This is the exact name
* that would be used by other instances to make calls.
*
- * @param refresh true if the information needs to be refetched, false otherwise.
+ * @param refresh
+ * true if the information needs to be refetched, false
+ * otherwise.
* @return hostname of this instance which is identifiable by other
* instances for making remote calls.
*/
@@ -187,7 +193,7 @@
/**
* Get the IPAdress of the instance. This information is for academic
* purposes only as the communication from other instances primarily happen
- * using the information supplied in {@link #getHostName()}.
+ * using the information supplied in {@link #getHostName(boolean)}.
*
* @return the ip address of this instance.
*/
@@ -46,7 +46,9 @@
* {@link InstanceInfo.InstanceStatus#DOWN} with eureka. If the instance was
* already marked {@link InstanceInfo.InstanceStatus#DOWN} , returning true
* here will mark the instance back to
- * {@link InstanceInfo.InstanceStatus#UP}
+ * {@link InstanceInfo.InstanceStatus#UP}.
+ *
+ * @return true if the call back returns healthy, false otherwise.
*/
boolean isHealthy();
}
Oops, something went wrong.

0 comments on commit e6e92c9

Please sign in to comment.