Fixing javadoc for strict java 8 javadoc tool

kuali · May 14, 2015 · 93ee4fe · 93ee4fe
1 parent 6ae173e
commit 93ee4fe
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 31 deletions.
diff --git a/...impl/src/main/java/org/kuali/coeus/s2sgen/impl/budget/S2SBudgetCalculatorServiceImpl.java b/...impl/src/main/java/org/kuali/coeus/s2sgen/impl/budget/S2SBudgetCalculatorServiceImpl.java
@@ -1134,7 +1134,7 @@ public IndirectCostDto getIndirectCosts(BudgetContract budget, BudgetPeriodContr
      * This method computes Other Dirtect Costs for the given {@link org.kuali.coeus.common.budget.api.period.BudgetPeriodContract} and Sponsor
      * 
      * @param budgetPeriod given BudgetPeriod.
-     * @return List<OtherDirectCostInfo> list of OtherDirectCostInfo corresponding to the BudgetPeriod object.
+     * @return List<&lt;OtherDirectCostInfo&gt; list of OtherDirectCostInfo corresponding to the BudgetPeriod object.
      */
     protected List<OtherDirectCostInfoDto> getOtherDirectCosts(BudgetPeriodContract budgetPeriod, BudgetContract budget) {
         OtherDirectCostInfoDto otherDirectCostInfo = new OtherDirectCostInfoDto();
@@ -1530,7 +1530,7 @@ public List<? extends BudgetCategoryMapContract> getBudgetCategoryMapList(List<S
      * This method computes the Equipment Costs for a given {@link org.kuali.coeus.common.budget.api.period.BudgetPeriodContract}
      * 
      * @param budgetPeriod given BudgetPeriod.
-     * @return List<EquipmentInfo> list of equipment cost corresponding to the BudgetPeriod object.
+     * @return List&lt;EquipmentInfo&gt; list of equipment cost corresponding to the BudgetPeriod object.
      */
     protected List<EquipmentDto> getEquipment(BudgetPeriodContract budgetPeriod, BudgetContract budget) {
         List<CostDto> cvExtraEquipment = new ArrayList<CostDto>();
@@ -1628,7 +1628,7 @@ protected List<EquipmentDto> getEquipment(BudgetPeriodContract budgetPeriod, Bud
      * @param budgetPeriod given BudgetPeriod.
      * @param pdDoc Proposal Development Document.
      * @param numKeyPersons number of key persons.
-     * @return List<List<KeyPersonInfo>> list of KeyPersonInfo list.
+     * @return List&lt;List&lt;KeyPersonInfo&gt;&gt; list of KeyPersonInfo list.
      */
     protected List<List<KeyPersonDto>> getKeyPersons(BudgetPeriodContract budgetPeriod, ProposalDevelopmentDocumentContract pdDoc,
             int numKeyPersons, BudgetContract budget) {

diff --git a/...-s2sgen-impl/src/main/java/org/kuali/coeus/s2sgen/impl/generate/S2SBaseFormGenerator.java b/...-s2sgen-impl/src/main/java/org/kuali/coeus/s2sgen/impl/generate/S2SBaseFormGenerator.java
@@ -126,7 +126,7 @@ public abstract class S2SBaseFormGenerator implements S2SFormGenerator, Initiali
      * Gets the list of attachments associated with a form. As the form generator fills the form data, the attachment information is
      * stored into the instance variable
      * 
-     * @return List<AttachementData> List of attachments associated with the the form. Returns an empty list if no attachment is
+     * @return List&lt;AttachementData&gt; List of attachments associated with the the form. Returns an empty list if no attachment is
      *         available.
      */
 

diff --git a/.../src/main/java/org/kuali/coeus/s2sgen/impl/generate/support/CommonSF424BaseGenerator.java b/.../src/main/java/org/kuali/coeus/s2sgen/impl/generate/support/CommonSF424BaseGenerator.java
@@ -74,7 +74,7 @@ public void setQuestionAnswerService(QuestionAnswerService questionAnswerService
      * This method returns a map containing the answers related to EOState REview for a given proposal
      *
      * @param pdDoc Proposal Development Document.
-     * @return Map<String, String> map containing the answers related to EOState Review for a given proposal.
+     * @return Map&lt;String, String&gt; map containing the answers related to EOState Review for a given proposal.
      */
     public Map<String, String> getEOStateReview(ProposalDevelopmentDocumentContract pdDoc) {
         Map<String, String> stateReview = new HashMap<String, String>();

diff --git a/.../main/java/org/kuali/coeus/s2sgen/impl/generate/support/PHS398ChecklistV1_3Generator.java b/.../main/java/org/kuali/coeus/s2sgen/impl/generate/support/PHS398ChecklistV1_3Generator.java
@@ -303,7 +303,7 @@ private YesNoDataType.Enum getYNQAnswer(Integer questionID) {
 
 	/**
 	 * This method creates {@link XmlObject} of type
-	 * {@link PHS398Checklist13Document by populating data from the given
+	 * {@link PHS398Checklist13Document} by populating data from the given
 	 * {@link ProposalDevelopmentDocumentContract}
 	 * 
 	 * @param proposalDevelopmentDocument

diff --git a/...impl/src/main/java/org/kuali/coeus/s2sgen/impl/generate/support/RRSF424BaseGenerator.java b/...impl/src/main/java/org/kuali/coeus/s2sgen/impl/generate/support/RRSF424BaseGenerator.java
@@ -161,7 +161,7 @@ public boolean isSponsorInHierarchy(DevelopmentProposalContract sponsorable, Str
      * This method creates and returns Map of submission details like submission type, description and Revision code
      *
      * @param pdDoc Proposal Development Document.
-     * @return Map<String, String> Map of submission details.
+     * @return Map&lt;String, String&gt; Map of submission details.
      */
     public Map<String, String> getSubmissionType(ProposalDevelopmentDocumentContract pdDoc) {
         Map<String, String> submissionInfo = new HashMap<String, String>();

diff --git a/...ava/org/kuali/coeus/s2sgen/impl/generate/support/S2SAdobeFormAttachmentBaseGenerator.java b/...ava/org/kuali/coeus/s2sgen/impl/generate/support/S2SAdobeFormAttachmentBaseGenerator.java
@@ -266,7 +266,7 @@ protected void addSubAwdAttachments(BudgetSubAwardsContract budgetSubAwards) {
      * This method is used to get BudgetSubAwrads from ProposalDevelopmentDocumentContract
      * 
      * @param proposalDevelopmentDocument (ProposalDevelopmentDocumentContract)
-     * @return List<BudgetSubAwards> list of budget sub awards.
+     * @return List&lt;BudgetSubAwards&gt; list of budget sub awards.
      */
     protected List<BudgetSubAwardsContract> getBudgetSubAwards(ProposalDevelopmentDocumentContract proposalDevelopmentDocument,
             String namespace,boolean checkNull) {

diff --git a/coeus-s2sgen-impl/src/main/java/org/kuali/coeus/s2sgen/impl/hash/GrantApplicationHash.java b/coeus-s2sgen-impl/src/main/java/org/kuali/coeus/s2sgen/impl/hash/GrantApplicationHash.java
@@ -72,7 +72,7 @@ private GrantApplicationHash() {
 	 *            The Grants.gov application XML.
 	 * @return The SHA-1 hash value of &lt;grant:forms&gt; tag inside the
 	 *         application XML.
-	 * @throws Exception
+	 * @throws S2SException
 	 *             When the XML cannot be parsed.
 	 */
 	public final static String computeGrantFormsHash(String xml) throws S2SException {
@@ -91,7 +91,6 @@ public final static String computeGrantFormsHash(String xml) throws S2SException
 	 * 
 	 * @param attachment
 	 * @return The SHA-1 hash value of the attachment byte array.
-	 * @throws Exception
 	 */
 	public final static String computeAttachmentHash(byte[] attachment) {
 

diff --git a/coeus-s2sgen-impl/src/main/java/org/kuali/coeus/s2sgen/impl/print/FormPrintServiceImpl.java b/coeus-s2sgen-impl/src/main/java/org/kuali/coeus/s2sgen/impl/print/FormPrintServiceImpl.java
@@ -115,9 +115,6 @@ public class FormPrintServiceImpl implements FormPrintService {
 	 * @param pdDoc (ProposalDevelopmentDocumentContract)
 	 * @return {@link KcFile} which contains all information
 	 *         related to the generated PDF
-	 * @throws
-	 * @throws S2SException
-	 * 
 	 */
     @Override
 	public FormPrintResult printForm(Object pdDoc) throws S2SException {
@@ -234,7 +231,6 @@ protected String getFileNameForFormPrinting(ProposalDevelopmentDocumentContract
 	 * @param pdDoc
 	 *            Proposal Development Document.
 	 * @return ByteArrayOutputStream[] of the submitted application data.
-	 * @throws S2SException
 	 */
 	protected PrintableResult getSubmittedPDFStream(
 			ProposalDevelopmentDocumentContract pdDoc) throws S2SException {
@@ -351,7 +347,6 @@ protected String findSubmittedXml(S2sAppSubmissionContract appSubmission) {
 	 * @param pdDoc
 	 *            ProposalDevelopmentDocumentContract
 	 * @return ByteArrayOutputStream[] PDF byte Array
-	 * @throws S2SException
 	 */
 	protected PrintableResult getPDFStream(ProposalDevelopmentDocumentContract pdDoc)
 			throws S2SException {
@@ -538,9 +533,8 @@ protected S2sAppSubmissionContract getLatestS2SAppSubmission(
 	 * This method sorts all the forms in order as specified in
 	 * S2sFormBinding.xml and returns the list of namespaces in sorted order.
 	 * 
-	 * @param s2sOppForms
-	 *            list of S2sOppForms.
-	 * @return List<String> list of sorted name spaces.
+	 * @param s2sOppForms list of S2sOppForms.
+	 * @return List&lt;String&gt; list of sorted name spaces.
 	 */
 	protected List<String> getSortedNameSpaces(String proposalNumber,List<? extends S2sOppFormsContract> s2sOppForms) {
 		List<String> orderedNamespaces = new ArrayList<String>();
@@ -575,23 +569,11 @@ private List<String> findUserAttachedNamespaces(String proposalNumber) {
         return userAttachedFormService.findFormNamespaces(proposalNumber);
     }
 
-    /**
-	 * 
-	 * Setter for {@link org.kuali.coeus.s2sgen.impl.generate.S2SFormGeneratorRetrievalService}
-	 * 
-	 * @param s2SFormGeneratorService
-	 */
 	public void setS2SFormGeneratorService(
 			S2SFormGeneratorRetrievalService s2SFormGeneratorService) {
 		this.s2SFormGeneratorService = s2SFormGeneratorService;
 	}
 
-	/**
-	 * 
-	 * Setter for {@link org.kuali.coeus.s2sgen.impl.generate.S2SFormGeneratorRetrievalService}
-	 * 
-	 * @param s2SValidatorService
-	 */
 	public void setS2SValidatorService(S2SValidatorService s2SValidatorService) {
 		this.s2SValidatorService = s2SValidatorService;
 	}

diff --git a/...sgen-impl/src/main/java/org/kuali/coeus/s2sgen/impl/validate/S2SValidatorServiceImpl.java b/...sgen-impl/src/main/java/org/kuali/coeus/s2sgen/impl/validate/S2SValidatorServiceImpl.java
@@ -56,7 +56,6 @@ public class S2SValidatorServiceImpl implements S2SValidatorService {
      * @param formObject XML document as {@link}XMLObject
      * @param errors List list of XPaths of the error nodes.
      * @return validation result true if valid false otherwise.
-     * @see S2SValidatorService#validate(org.apache.xmlbeans.XmlObject, java.util.List)
      */
     public boolean validate(XmlObject formObject, List<AuditError> errors,String formName) {