Uploaded image for project: 'EJBCA'
  1. EJBCA
  2. ECA-6265

Fix javadoc compilation warnings

    Details

    • Type: Bug
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: EJBCA 6.10.0
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      Besides the errors fixed in ECA-6264, the command ant javadoc currently produces a slew of warnings. These should be fixed.

      • Auditable.java:64: warning - Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
      • Auditable.java:64: warning - Tag @see: reference not found: AuditLogBasicExporter public static varaibles
      • Auditable.java:64: warning - @param argument "c" is not a parameter name.
      • AuditLogReportElem.java:92: warning - @param argument "reasons" is not a parameter name.
      • SecurityEventsAuditorSession.java:36: warning - Tag @link: reference not found
      • SecurityEventsAuditorSession.java:69: warning - Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
      • SecurityEventsAuditorSession.java:69: warning - Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
      • SigningFileOutputStream.java:70: warning - Tag @return cannot be used in constructor documentation. It can only be used in the following types of documentation: method.
      • SigningFileOutputStream.java:70: warning - @param argument "exportFile" is not a parameter name.
      • LocalJvmOnlyAuthenticationToken.java:42: warning - Tag @see:illegal character: "60" in "org.cesecore.authentication.tokens.AuthenticationToken.AuthenticationToken(Set<? extends Principal>, Set<?>)"
      • LocalJvmOnlyAuthenticationToken.java:42: warning - Tag @see:illegal character: "63" in "org.cesecore.authentication.tokens.AuthenticationToken.AuthenticationToken(Set<? extends Principal>, Set<?>)"
      • LocalJvmOnlyAuthenticationToken.java:42: warning - Tag @see:illegal character: "62" in "org.cesecore.authentication.tokens.AuthenticationToken.AuthenticationToken(Set<? extends Principal>, Set<?>)"
      • LocalJvmOnlyAuthenticationToken.java:42: warning - Tag @see:illegal character: "60" in "org.cesecore.authentication.tokens.AuthenticationToken.AuthenticationToken(Set<? extends Principal>, Set<?>)"
      • LocalJvmOnlyAuthenticationToken.java:42: warning - Tag @see:illegal character: "63" in "org.cesecore.authentication.tokens.AuthenticationToken.AuthenticationToken(Set<? extends Principal>, Set<?>)"
      • LocalJvmOnlyAuthenticationToken.java:42: warning - Tag @see:illegal character: "62" in "org.cesecore.authentication.tokens.AuthenticationToken.AuthenticationToken(Set<? extends Principal>, Set<?>)"
      • LocalJvmOnlyAuthenticationToken.java:42: warning - Tag @see: missing '#': "org.cesecore.authentication.tokens.AuthenticationToken.AuthenticationToken(Set<? extends Principal>, Set<?>)"
      • LocalJvmOnlyAuthenticationToken.java:42: warning - Tag @see: can't find org.cesecore.authentication.tokens.AuthenticationToken.AuthenticationToken(Set<? extends Principal>, Set<?>) in org.cesecore.authentication.tokens.LocalJvmOnlyAuthenticationToken
      • AccessSet.java:67: warning - Tag @link: can't find createEmptyAccessSet() in org.cesecore.authorization.access.AccessSet
      • AuthorizationCacheReload.java:28: warning - Tag @link: missing '#': "org.cesecore.authorization.cache.AccessTreeUpdateSessionLocal.addReloadEvent(AuthorizationCacheReloadListener)"
      • AuthorizationCacheReload.java:28: warning - Tag @link: can't find org.cesecore.authorization.cache.AccessTreeUpdateSessionLocal.addReloadEvent(AuthorizationCacheReloadListener) in org.cesecore.authorization.access.AuthorizationCacheReload
      • AccessRuleData.java:74: warning - @param argument "accessruleName" is not a parameter name.
      • ccessRuleData.java:74: warning - @param argument "recursive" is not a parameter name.
      • AccessRuleData.java:98: warning - @param argument "accessruleName" is not a parameter name.
      • AccessRuleData.java:98: warning - @param argument "recursive" is not a parameter name.
      • AccessUserAspectData.java:219: warning - @param argument "tokenType" is not a parameter name.
      • CA.java:289: warning - @See is an unknown tag – same as a known tag except for case.
      • CADoesntExistsException.java:53: warning - @param argument "msg" is not a parameter name.
      • CAInfo.java:476: warning - @param argument "doEnforceUniqueSubjectDNSerialnumber" is not a parameter name.
      • CANameChangeRenewalException.java:50: warning - @param argument "msg" is not a parameter name.
      • CaSession.java:129: warning - @param argument "admin" is not a parameter name.
      • CaSession.java:142: warning - @param argument "admin" is not a parameter name.
      • CaSession.java:154: warning - @param argument "admin" is not a parameter name.
      • CertificateGenerationParams.java:41: warning - @note is an unknown tag.
      • CertificateGenerationParams.java:41: warning - @note is an unknown tag.
      • CAToken.java:103: warning - @param argument "data" is not a parameter name.
      • ExtendedCAServiceNotActiveException.java:41: warning - @param argument "msg" is not a parameter name.
      • ExtendedCAServiceRequestException.java:42: warning - @param argument "msg" is not a parameter name.
      • IllegalExtendedCAServiceRequestException.java:42: warning - @param argument "msg" is not a parameter name.
      • CaCertificateCache.java:102: warning - @return tag cannot be used in method with void return type.
      • CertificateValidity.java:82: warning - @See is an unknown tag – same as a known tag except for case.
      • CertificateValidity.java:335: warning - @param argument "cacert" is not a parameter name.
      • SernoGenerator.java:47: warning - @param argument "the" is not a parameter name.
      • SernoGenerator.java:55: warning - @param argument "an" is not a parameter name.
      • SernoGenerator.java:62: warning - @param argument "the" is not a parameter name.
      • CertificateCreateException.java:88: warning - @param argument "message" is not a parameter name.
      • CertificateCreateSessionLocal.java:178: warning - @param argument "RequestMessage" is not a parameter name.
      • CertificateCreateSessionLocal.java:178: warning - @param argument "keyUsage" is not a parameter name.
      • CertificateCreateSessionLocal.java:190: warning - @param argument "CA" is not a parameter name.
      • CertificateData.java:1083: warning - @return tag has no arguments.
      • CertificateData.java:1102: warning - @return tag has no arguments.
      • CertificateData.java:402: warning - @returns is an unknown tag.
      • CertificateData.java:411: warning - @returns is an unknown tag.
      • CertificateData.java:531: warning - @param argument "username" is not a parameter name.
      • CertificateData.java:1102: warning - @param argument "certificateProfileId" is not a parameter name.
      • CertificateRevokeException.java:40: warning - @param argument "msg" is not a parameter name.
      • CertificateStoreSessionLocal.java:186: warning - Parameter "issuerDn" is documented more than once.
      • CertificateStoreSessionLocal.java:209: warning - @param argument "revokeDate" is not a parameter name.
      • CertificateStoreSessionLocal.java:241: warning - @param argument "fingerprint" is not a parameter name.
      • CertificateWrapper.java:30: warning - Tag @link: reference not found: CertificateSerializableWrapper
      • HashID.java:102: warning - @param argument "cert" is not a parameter name.
      • IllegalKeyException.java:43: warning - @param argument "msg" is not a parameter name.
      • AvailableCustomCertificateExtensionsConfiguration.java:113: warning - @return tag has no arguments.
      • CertificateExtension.java:71: warning - @param argument "The" is not a parameter name.
      • CertificateExtension.java:85: warning - @param argument "The" is not a parameter name.
      • CertificateExtension.java:98: warning - @param argument "flag" is not a parameter name.
      • CertificateExtension.java:121: warning - @param argument "id," is not a parameter name.
      • CertificateExtension.java:121: warning - @param argument "oID," is not a parameter name.
      • CertificateExtension.java:121: warning - @param argument "config" is not a parameter name.
      • CertificateExtensionFactory.java:106: warning - @returns is an unknown tag.
      • CustomCVCertificateExtension.java:42: warning - @param argument "isCSR" is not a parameter name.
      • NameConstraint.java:218: warning - Tag @see: reference not found: parseNameConstraintEntry
      • RequestMessage.java:228: warning - @param argument "reqtype" is not a parameter name.
      • RequestMessage.java:235: warning - @param argument "reqId" is not a parameter name.
      • RequestMessageUtils.java:114: warning - @param argument "bytes" is not a parameter name.
      • ResponseMessage.java:56: warning - @param argument "includeCACert" is not a parameter name.
      • ResponseMessage.java:154: warning - @param argument "cert" is not a parameter name.
      • ResponseMessage.java:190: warning - @param argument "String" is not a parameter name.
      • ResponseMessage.java:204: warning - @param argument "reqId" is not a parameter name.
      • ResponseMessage.java:211: warning - @param argument "RequestMessage" is not a parameter name.
      • SimpleRequestMessage.java:119: warning - @param argument "the" is not a parameter name.
      • X509ResponseMessage.java:208: warning - Tag @see: can't find setSignKeyInfo() in org.cesecore.certificates.certificate.request.X509ResponseMessage
      • CertificatePolicy.java:92: warning - @param argument "uri" is not a parameter name.
      • CertificateProfile.java:731: warning - Tag @see:illegal character: "123" in @see setCertificateValidityOffset(String)
      • CertificateProfile.java:731: warning - Tag @see:illegal character: "64" in @see setCertificateValidityOffset(String)
      • CertificateProfile.java:753: warning - Tag @see:illegal character: "123" in link {org.cesecore.util.SimpleTime}
        * CertificateProfile.java:753: warning - Tag @see:illegal character: "125" in link{org.cesecore.util.SimpleTime}
      • CertificateProfile.java:753: warning - Tag @see: can't find link {org.cesecore.util.SimpleTime}

        in org.cesecore.certificates.certificateprofile.CertificateProfile

      • CertificateProfile.java:1273: warning - Tag @see: malformed: "CertificateConstants.CERTTYPE_ROOTCA, etc"
      • CertificateProfile.java:1280: warning - Tag @see: malformed: "CertificateConstants.CERTTYPE_ROOTCA, etc"
      • CertificateProfile.java:1772: warning - @return tag has no arguments.
      • CertificateProfile.java:707: warning - @See is an unknown tag – same as a known tag except for case.
      • CertificateProfile.java:707: warning - @See is an unknown tag – same as a known tag except for case.
      • CertificateProfile.java:722: warning - @See is an unknown tag – same as a known tag except for case.
      • CertificateProfile.java:722: warning - @See is an unknown tag – same as a known tag except for case.
      • CertificateProfile.java:731: warning - Tag @see: reference not found: setCertificateValidityOffset(String)
      • CertificateProfile.java:1273: warning - Tag @see: reference not found: CertificateConstants.CERTTYPE_ROOTCA, etc
      • CertificateProfile.java:1280: warning - Tag @see: reference not found: CertificateConstants.CERTTYPE_ROOTCA, etc
      • CertificateProfile.java:1398: warning - Tag @see: reference not found: org.cesecore.certificates.util.core.model.AlgorithmConstants.AVAILABLE_SIGALGS
      • CertificateProfile.java:1412: warning - Tag @see: reference not found: org.cesecore.certificates.util.core.model.AlgorithmConstants.AVAILABLE_SIGALGS
      • CertificateProfile.java:1677: warning - @param argument "Set" is not a parameter name.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned
              Reporter:
              mikek Mike Agrenius Kushner
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:

                  Time Tracking

                  Estimated:
                  Original Estimate - 4 hours
                  4h
                  Remaining:
                  Remaining Estimate - 4 hours
                  4h
                  Logged:
                  Time Spent - Not Specified
                  Not Specified