lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Modify JavaDoc

Browse Source 
Signed-off-by: SirWayne <dennis.melzer@bosch-si.com>
This commit is contained in:
SirWayne
2016-05-18 14:28:31 +02:00
parent 5bb24c78ad
commit 05615a9e86
24 changed files with 36 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
hawkbit-ddi-api/src/main/java/org/eclipse/hawkbit/ddi/json/model/DdiCancel.java
View File

@@ -24,7 +24,7 @@ public class DdiCancel {
* Parameterized constructor.
*
* @param id
* of the {@link CancelAction}
* of the cancel action
* @param cancelAction
* the action
*/

4
hawkbit-ddi-api/src/main/java/org/eclipse/hawkbit/ddi/json/model/DdiCancelActionToStop.java
View File

@@ -11,7 +11,7 @@ package org.eclipse.hawkbit.ddi.json.model;
import javax.validation.constraints.NotNull;
/**
* The {@link Action} that has to be stopped by the target.
* The action that has to be stopped by the target.
*/
public class DdiCancelActionToStop {
@@ -22,7 +22,7 @@ public class DdiCancelActionToStop {
* Parameterized constructor.
*
* @param stopId
* ID of the {@link Action} to be stoppedW
* ID of the action to be stoppedW
*/
public DdiCancelActionToStop(final String stopId) {
super();

4
hawkbit-ddi-api/src/main/java/org/eclipse/hawkbit/ddi/json/model/DdiDeployment.java
View File

@@ -13,7 +13,7 @@ import java.util.List;
import com.fasterxml.jackson.annotation.JsonValue;
/**
* Detailed {@link UpdateAction} information.
* Detailed update action information.
*/
public class DdiDeployment {
@@ -57,7 +57,7 @@ public class DdiDeployment {
}
/**
* The handling type for the update {@link Action}.
* The handling type for the update action.
*/
public enum HandlingType {

4
hawkbit-ddi-api/src/main/java/org/eclipse/hawkbit/ddi/json/model/DdiDeploymentBase.java
View File

@@ -15,7 +15,7 @@ import org.springframework.hateoas.ResourceSupport;
import com.fasterxml.jackson.annotation.JsonProperty;
/**
* {@link UpdateAction} resource.
* Update action resource.
*/
public class DdiDeploymentBase extends ResourceSupport {
@@ -30,7 +30,7 @@ public class DdiDeploymentBase extends ResourceSupport {
* Constructor.
*
* @param id
* of the {@link UpdateAction}
* of the update action
* @param deployment
* details.
*/

38
hawkbit-ddi-api/src/main/java/org/eclipse/hawkbit/ddi/rest/api/DdiRootControllerRestApi.java
View File

@@ -40,10 +40,9 @@ public interface DdiRootControllerRestApi {
* Returns all artifacts of a given software module and target.
*
* @param targetid
* of the {@link Target} that matches to
* {@link Target#getControllerId()}
* of the target that matches to controller id
* @param softwareModuleId
* of the {@link SoftwareModule}
* of the software module
* @return the response
*/
@RequestMapping(method = RequestMethod.GET, value = "/{targetid}/softwaremodules/{softwareModuleId}/artifacts", produces = {
@@ -56,8 +55,7 @@ public interface DdiRootControllerRestApi {
* Root resource for an individual {@link Target}.
*
* @param targetid
* of the {@link Target} that matches to
* {@link Target#getControllerId()}
* of the target that matches to controller id
* @param request
* the HTTP request injected by spring
* @return the response
@@ -71,11 +69,11 @@ public interface DdiRootControllerRestApi {
* partial (as specified by RFC7233 (Range Requests)) download request.
*
* @param targetid
* of the related
* of the related target
* @param softwareModuleId
* of the parent {@link SoftwareModule}
* of the parent software module
* @param fileName
* of the related {@link LocalArtifact}
* of the related local artifact
* @param response
* of the servlet
* @param request
@@ -94,11 +92,11 @@ public interface DdiRootControllerRestApi {
* Handles GET {@link DdiArtifact} MD5 checksum file download request.
*
* @param targetid
* of the related
* of the related target
* @param softwareModuleId
* of the parent {@link SoftwareModule}
* of the parent software module
* @param fileName
* of the related {@link LocalArtifact}
* of the related local artifact
* @param response
* of the servlet
* @param request
@@ -114,14 +112,13 @@ public interface DdiRootControllerRestApi {
@PathVariable("fileName") final String fileName);
/**
* Resource for {@link SoftwareModule} {@link UpdateAction}s.
* Resource for software module.
*
* @param targetid
* of the {@link Target} that matches to
* {@link Target#getControllerId()}
* of the target that matches to controller id
* @param actionId
* of the {@link DdiDeploymentBase} that matches to
* {@link Target#getActiveActions()}
* of the {@link DdiDeploymentBase} that matches to active
* actions.
* @param resource
* an hashcode of the resource which indicates if the action has
* been changed, e.g. from 'soft' to 'force' and the eTag needs
@@ -143,8 +140,7 @@ public interface DdiRootControllerRestApi {
* @param feedback
* to provide
* @param targetid
* of the {@link Target} that matches to
* {@link Target#getControllerId()}
* of the target that matches to controller id
* @param actionId
* of the action we have feedback for
* @param request
@@ -175,7 +171,7 @@ public interface DdiRootControllerRestApi {
@PathVariable("targetid") final String targetid);
/**
* {@link RequestMethod.GET} method for the {@link DdiCancel} action.
* RequestMethod.GET method for the {@link DdiCancel} action.
*
* @param targetid
* ID of the calling target
@@ -192,8 +188,8 @@ public interface DdiRootControllerRestApi {
@PathVariable("actionId") @NotEmpty final Long actionId);
/**
* {@link RequestMethod.POST} method receiving the {@link DdiActionFeedback}
* from the target.
* RequestMethod.POST method receiving the {@link DdiActionFeedback} from
* the target.
*
* @param feedback
* the {@link DdiActionFeedback} from the target.