Skip to content

Commit 77c60c0

Browse files
committed
Fix javadoc errors in ocpp-v1_6
1 parent 638ba26 commit 77c60c0

4 files changed

Lines changed: 20 additions & 4 deletions

File tree

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/ServerCoreProfile.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ public Confirmation handleRequest(UUID sessionIndex, Request request) {
9797
/**
9898
* Create a {@link ChangeAvailabilityRequest} with required values.
9999
*
100-
* @param connectorId integer, must be a non-negative number. * @param type the {@link
101-
* AvailabilityType} of the connector.
100+
* @param type the {@link AvailabilityType} of the connector.
101+
* @param connectorId integer, must be a non-negative number.
102102
* @return an instance of {@link ChangeAvailabilityRequest}.
103103
* @see ChangeAvailabilityRequest
104104
* @see ChangeAvailabilityFeature

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/ServerFirmwareManagementProfile.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ public GetDiagnosticsRequest createGetDiagnosticsRequest(String location) {
8888
/**
8989
* Create a client {@link UpdateFirmwareRequest} with required values.
9090
*
91-
* @param location String, a URI with the firmware * @param retrieveDate ZonedDateTime, date and
92-
* time of retrieving
91+
* @param location String, a URI with the firmware
92+
* @param retrieveDate ZonedDateTime, date and time of retrieving
9393
* @return an instance of {@link UpdateFirmwareRequest}
9494
* @see UpdateFirmwareRequest
9595
* @see UpdateFirmwareFeature

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/securityext/ClientSecurityExtProfile.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ public Confirmation handleRequest(UUID sessionIndex, Request request) {
117117
/**
118118
* Create a client {@link LogStatusNotificationRequest} with required values.
119119
*
120+
* @param status the {@link UploadLogStatusEnumType}.
120121
* @return an instance of {@link LogStatusNotificationRequest}.
121122
* @see LogStatusNotificationRequest
122123
* @see LogStatusNotificationFeature
@@ -129,6 +130,8 @@ public LogStatusNotificationRequest createLogStatusNotificationRequest(
129130
/**
130131
* Create a client {@link SecurityEventNotificationRequest} with required values.
131132
*
133+
* @param type the type {@link String}
134+
* @param timestamp the {@link ZonedDateTime} stamp
132135
* @return an instance of {@link SecurityEventNotificationRequest}
133136
* @see SecurityEventNotificationRequest
134137
* @see SecurityEventNotificationFeature
@@ -141,6 +144,7 @@ public SecurityEventNotificationRequest createSecurityEventNotificationRequest(
141144
/**
142145
* Create a client {@link SignCertificateRequest} with required values.
143146
*
147+
* @param csr the certificate signing request as a PEM encoded {@link String}
144148
* @return an instance of {@link SignCertificateRequest}.
145149
* @see SignCertificateRequest
146150
* @see SignCertificateFeature
@@ -152,6 +156,7 @@ public SignCertificateRequest createSignCertificateRequest(String csr) {
152156
/**
153157
* Create a client {@link SignedFirmwareStatusNotificationRequest}.
154158
*
159+
* @param status the {@link FirmwareStatusEnumType}
155160
* @return an instance of {@link SignedFirmwareStatusNotificationRequest}
156161
* @see SignedFirmwareStatusNotificationRequest
157162
* @see SignedFirmwareStatusNotificationFeature

ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/securityext/ServerSecurityExtProfile.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ public Confirmation handleRequest(UUID sessionIndex, Request request) {
116116
/**
117117
* Create a client {@link CertificateSignedRequest} with required values.
118118
*
119+
* @param certificateChain the certificate chain as a PEM encoded {@link String}
119120
* @return an instance of {@link CertificateSignedRequest}
120121
* @see CertificateSignedRequest
121122
* @see CertificateSignedFeature
@@ -127,6 +128,7 @@ public CertificateSignedRequest createCertificateSignedRequest(String certificat
127128
/**
128129
* Create a client {@link DeleteCertificateRequest} with required values.
129130
*
131+
* @param certificateHashData the {@link CertificateHashDataType}
130132
* @return an instance of {@link DeleteCertificateRequest}
131133
* @see DeleteCertificateRequest
132134
* @see DeleteCertificateFeature
@@ -139,6 +141,7 @@ public DeleteCertificateRequest createDeleteCertificateRequest(
139141
/**
140142
* Create a client {@link ExtendedTriggerMessageFeature}.
141143
*
144+
* @param requestedMessage the {@link MessageTriggerEnumType}
142145
* @return an instance of {@link ExtendedTriggerMessageRequest}
143146
* @see ExtendedTriggerMessageRequest
144147
* @see ExtendedTriggerMessageFeature
@@ -151,6 +154,7 @@ public ExtendedTriggerMessageRequest createExtendedTriggerMessageRequest(
151154
/**
152155
* Create a client {@link GetInstalledCertificateIdsRequest} required values.
153156
*
157+
* @param certificateType the {@link CertificateUseEnumType}
154158
* @return an instance of {@link GetInstalledCertificateIdsRequest}
155159
* @see GetInstalledCertificateIdsRequest
156160
* @see GetInstalledCertificateIdsFeature
@@ -163,6 +167,9 @@ public GetInstalledCertificateIdsRequest createGetInstalledCertificateIdsRequest
163167
/**
164168
* Create a client {@link GetLogRequest}.
165169
*
170+
* @param logType the {@link LogEnumType}
171+
* @param requestId the request identifier
172+
* @param log the {@link LogParametersType}
166173
* @return an instance of {@link GetLogRequest}
167174
* @see GetLogRequest
168175
* @see GetLogFeature
@@ -175,6 +182,8 @@ public GetLogRequest createGetLogRequest(
175182
/**
176183
* Create a client {@link InstallCertificateRequest} with required values.
177184
*
185+
* @param certificateType the {@link CertificateUseEnumType}
186+
* @param certificate the certificate as a PEM encoded {@link String}
178187
* @return an instance of {@link InstallCertificateRequest}
179188
* @see InstallCertificateRequest
180189
* @see InstallCertificateFeature
@@ -187,6 +196,8 @@ public InstallCertificateRequest createInstallCertificateRequest(
187196
/**
188197
* Create a client {@link SignedUpdateFirmwareRequest} with required values.
189198
*
199+
* @param requestId the request identifier
200+
* @param firmware the {@link FirmwareType}
190201
* @return an instance of {@link SignedUpdateFirmwareRequest}
191202
* @see SignedUpdateFirmwareRequest
192203
* @see SignedUpdateFirmwareFeature

0 commit comments

Comments
 (0)