search

spdx / tools

SPDX Tools
Apache License 2.0
127 stars 69 forks source link

Missing Documentation Fails Maven Build Against Java 8 Environment #12

Open romeara opened 9 years ago

romeara commented 9 years ago

There are several partial JavaDoc statements present in the library which make it difficult to use for someone trying to get familiar with it. In addition, the started documentation which isn't finished is causing the Maven build to fail if someone doesn't force Maven to use Java 7 or earlier for its own operations (there is a strict setting for things like "param" annotations to have text).

Note: There is a workaround for the Java 8 failure, but its really just a side-effect, the documentation itself is the bigger concern.

I will work on pull request improving this - I will combine these changes with the changes for #6 in small batches to prevent overwriting over a hundred files for line ending reasons

romeara commented 9 years ago

Relevant "mvn clean install" output:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar (attach-javadocs) on project spdx-tools: MavenReportException: Error while creating archive:
[ERROR] Exit code: 1 - C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\AbstractFileCompareSheet.java:68: warning: no description for @param
[ERROR] * @param wb
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\AbstractFileCompareSheet.java:69: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\AbstractFileCompareSheet.java:71: warning: no @param for columnWidth
[ERROR] public static void create(Workbook wb, String sheetName, int columnWidth) {
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\AbstractFileCompareSheet.java:103: warning: no @param for comparer
[ERROR] public void importCompareResults(SpdxComparer comparer, SpdxFile[][] files, String[] docNames) throws SpdxCompareException {
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\AbstractFileCompareSheet.java:103: warning: no @throws for org.spdx.compare.SpdxCompareException
[ERROR] public void importCompareResults(SpdxComparer comparer, SpdxFile[][] files, String[] docNames) throws SpdxCompareException {
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\AbstractFileCompareSheet.java:51: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\AbstractFileCompareSheet.java:52: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:46: warning: no description for @param
[ERROR] * @param annotation
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:47: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:66: warning: no description for @param
[ERROR] * @param checksums
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:67: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:83: warning: no description for @param
[ERROR] * @param checksum
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:84: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:97: warning: no description for @param
[ERROR] * @param licenseInfoFromFiles
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:98: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:114: warning: no description for @param
[ERROR] * @param annotations
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:115: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:146: warning: no description for @param
[ERROR] * @param relationships
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:147: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:185: warning: no description for @param
[ERROR] * @param fileTypes
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:186: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:201: warning: no description for @param
[ERROR] * @param typeStr
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:202: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:203: warning: no description for @throws
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:226: warning: no description for @param
[ERROR] * @param checksumsString
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:227: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareHelper.java:228: warning: no description for @throws
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareTemplateOutputHandler.java:64: warning: no description for @param
[ERROR] * @param text
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CompareTemplateOutputHandler.java:224: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\licenseTemplate\ILicenseTemplateOutputHandler.java:30: warning: no description for @param
[ERROR] * @param text
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\licenseTemplate\ILicenseTemplateOutputHandler.java:36: warning: no description for @param
[ERROR] * @param text
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\licenseTemplate\ILicenseTemplateOutputHandler.java:42: warning: no description for @param
[ERROR] * @param rule
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\licenseTemplate\ILicenseTemplateOutputHandler.java:48: warning: no description for @param
[ERROR] * @param rule
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\licenseTemplate\ILicenseTemplateOutputHandler.java:54: warning: no description for @param
[ERROR] * @param rule
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CreatorSheet.java:57: warning: no description for @param
[ERROR] * @param wb
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CreatorSheet.java:58: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CreatorSheet.java:78: warning: no description for @param
[ERROR] * @param comparer
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CreatorSheet.java:79: warning: no description for @param
[ERROR] * @param docNames
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CreatorSheet.java:80: warning: no description for @throws
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CreatorSheet.java:82: warning: no @throws for org.spdx.compare.SpdxCompareException
[ERROR] public void importCompareResults(SpdxComparer comparer, String[] docNames) throws SpdxCompareException, InvalidSPDXAnalysisException {
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CreatorSheet.java:40: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\CreatorSheet.java:41: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentAnnotationSheet.java:89: warning: no description for @param
[ERROR] * @param wb
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentAnnotationSheet.java:90: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentAnnotationSheet.java:128: warning: no description for @param
[ERROR] * @param comparer
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentAnnotationSheet.java:129: warning: no description for @param
[ERROR] * @param docNames
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentAnnotationSheet.java:130: warning: no description for @throws
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentAnnotationSheet.java:132: warning: no @throws for org.spdx.compare.SpdxCompareException
[ERROR] public void importCompareResults(SpdxComparer comparer, String[] docNames) throws SpdxCompareException, InvalidSPDXAnalysisException {
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentRelationshipSheet.java:84: warning: no description for @param
[ERROR] * @param wb
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentRelationshipSheet.java:85: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentRelationshipSheet.java:112: warning: no description for @param
[ERROR] * @param comparer
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentRelationshipSheet.java:113: warning: no description for @param
[ERROR] * @param docNames
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentRelationshipSheet.java:114: warning: no description for @throws
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentRelationshipSheet.java:116: warning: no @throws for org.spdx.compare.SpdxCompareException
[ERROR] public void importCompareResults(SpdxComparer comparer, String[] docNames) throws SpdxCompareException, InvalidSPDXAnalysisException {
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentSheet.java:99: warning: no description for @param
[ERROR] * @param wb
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentSheet.java:100: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentSheet.java:124: warning: no description for @throws
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentSheet.java:126: warning: no @throws for org.spdx.compare.SpdxCompareException
[ERROR] public void importCompareResults(SpdxComparer comparer, String[] docNames)  throws SpdxCompareException, InvalidSPDXAnalysisException {
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentSheet.java:67: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\DocumentSheet.java:68: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExternalReferencesSheet.java:96: warning: no description for @param
[ERROR] * @param wb
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExternalReferencesSheet.java:97: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExternalReferencesSheet.java:129: warning: no description for @param
[ERROR] * @param comparer
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExternalReferencesSheet.java:130: warning: no description for @param
[ERROR] * @param docNames
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExternalReferencesSheet.java:131: warning: no description for @throws
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExternalReferencesSheet.java:133: warning: no @throws for org.spdx.compare.SpdxCompareException
[ERROR] public void importCompareResults(SpdxComparer comparer, String[] docNames) throws SpdxCompareException, InvalidSPDXAnalysisException {
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExtractedLicenseSheet.java:89: warning: no description for @param
[ERROR] * @param wb
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExtractedLicenseSheet.java:90: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExtractedLicenseSheet.java:115: warning: no description for @param
[ERROR] * @param comparer
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExtractedLicenseSheet.java:116: warning: no description for @param
[ERROR] * @param docNames
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExtractedLicenseSheet.java:117: warning: no description for @throws
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExtractedLicenseSheet.java:119: warning: no @throws for org.spdx.compare.SpdxCompareException
[ERROR] public void importCompareResults(SpdxComparer comparer, String[] docNames) throws SpdxCompareException, InvalidSPDXAnalysisException {
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExtractedLicenseSheet.java:72: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ExtractedLicenseSheet.java:73: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileArtifactOfSheet.java:32: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileArtifactOfSheet.java:33: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileChecksumSheet.java:33: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileChecksumSheet.java:34: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileCommentSheet.java:32: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileCommentSheet.java:33: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileConcludedSheet.java:33: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileConcludedSheet.java:34: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileDependenciesSheet.java:34: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileDependenciesSheet.java:35: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileLicenseCommentsSheet.java:34: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileLicenseCommentsSheet.java:35: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileLicenseInfoSheet.java:34: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileLicenseInfoSheet.java:35: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileNoticeSheet.java:32: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileNoticeSheet.java:33: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileTypeSheet.java:36: warning: no description for @param
[ERROR] * @param workbook
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\FileTypeSheet.java:37: warning: no description for @param
[ERROR] * @param sheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\LicenseCompareHelper.java:112: warning: no description for @param
[ERROR] * @param licenseTextA
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\LicenseCompareHelper.java:113: warning: no description for @param
[ERROR] * @param licenseTextB
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\LicenseCompareHelper.java:114: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\LicenseCompareHelper.java:248: warning: no description for @param
[ERROR] * @param license1
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\LicenseCompareHelper.java:249: warning: no description for @param
[ERROR] * @param license2
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\LicenseCompareHelper.java:251: warning: no description for @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\LicenseCompareHelper.java:252: warning: no description for @throws
[ERROR] * @throws SpdxCompareException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\LicenseCompareHelper.java:327: warning: no description for @throws
[ERROR] * @throws SpdxCompareException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\spdxspreadsheet\AbstractSpreadsheet.java:118: error: reference not found
[ERROR] * @throws AnalyzeException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\ReviewerSheet.java:82: error: @param name not found
[ERROR] * @param reviewerSheetName
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\compare\SpdxPackageComparer.java:81: error: @param name not found
[ERROR] * @param licenseXlationMap A mapping between the license IDs from licenses in fileA to fileB
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\html\LicenseHTMLFile.java:87: error: @param name not found
[ERROR] * @param templateFileName File name for the Mustache template file
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\html\PackageContext.java:43: error: @param name not found
[ERROR] * @param doc
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\licenseTemplate\HtmlTemplateOutputHandler.java:173: error: @param name not found
[ERROR] * @param text text for the optional license string
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\licenseTemplate\SpdxLicenseTemplateHelper.java:229: error: self-closing element not allowed
[ERROR] * Converts an HTML string to text preserving line breaks for <br/> tags
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\merge\SpdxPackageInfoMerger.java:62: error: @param name not found
[ERROR] * @param subDocs
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\merge\SpdxPackageInfoMerger.java:196: error: @param name not found
[ERROR] * @param packagesArray
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\IModelContainer.java:47: error: @param name not found
[ERROR] * @param id
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXCreatorInformation.java:51: error: @param name not found
[ERROR] * @param name the name to set
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXDocument.java:1426: error: @param name not found
[ERROR] * @param creators the creators of the analysis
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXDocument.java:1427: error: reference not found
[ERROR] * @throws InvalidSPDXDocException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXDocument.java:264: error: @param name not found
[ERROR] * @param declaredLicenses the declaredLicenses to set
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXFile.java:440: error: exception not thrown: org.spdx.rdfparser.InvalidSPDXAnalysisException
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXFile.java:551: error: @param name not found
[ERROR] * @param noticeTexgt the noticeText to set
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXFile.java:663: error: exception not thrown: org.spdx.rdfparser.InvalidSPDXAnalysisException
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXFile.java:711: error: exception not thrown: org.spdx.rdfparser.InvalidSPDXAnalysisException
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXFile.java:755: error: exception not thrown: org.spdx.rdfparser.InvalidSPDXAnalysisException
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXFile.java:829: error: exception not thrown: org.spdx.rdfparser.InvalidSPDXAnalysisException
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\SPDXFile.java:1004: error: exception not thrown: org.spdx.rdfparser.InvalidSPDXAnalysisException
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\VerificationCodeGenerator.java:230: error: @param name not found
[ERROR] * @param skippedFiles
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\license\AnyLicenseInfo.java:72: error: @param name not found
[ERROR] * @param enclosingSpdxDoc The SPDX Document where this license will be contained
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\model\IRdfModel.java:36: error: @param name not found
[ERROR] * @param parentProperty
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\license\ExtractedLicenseInfo.java:113: error: @param name not found
[ERROR] * @param licenseResource
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\license\SimpleLicensingInfo.java:250: error: @param name not found
[ERROR] * @param model
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\license\SimpleLicensingInfo.java:252: error: @param name not found
[ERROR] * @param typeURI
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\license\LicenseException.java:165: error: @param name not found
[ERROR] * @param model
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\license\LicenseException.java:155: error: @param name not found
[ERROR] * @param token
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\license\LicenseInfoFactory.java:239: error: exception not thrown: org.spdx.rdfparser.InvalidSPDXAnalysisException
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\license\ListedLicenses.java:376: error: exception not thrown: org.spdx.rdfparser.InvalidSPDXAnalysisException
[ERROR] * @throws InvalidSPDXAnalysisException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\license\ListedLicenses.java:437: error: @param name not found
[ERROR] * @param uri
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\license\OrLaterOperator.java:43: error: @param name not found
[ERROR] * @param enclosingSpdxDocument document which includes the license
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\model\RdfModelObject.java:390: error: @param name not found
[ERROR] * @param element
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\model\RdfModelObject.java:734: error: @param name not found
[ERROR] * @param checksumValues
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\model\RdfModelObject.java:785: error: @param name not found
[ERROR] * @param checksumValue
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\model\RdfModelObject.java:868: error: @param name not found
[ERROR] * @param uri
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\model\RdfModelObject.java:960: error: @param name not found
[ERROR] * @param propSpdxExternalDocRef
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\model\SpdxElement.java:425: error: @param name not found
[ERROR] * @param describesRelationship
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\model\Relationship.java:143: error: @param name not found
[ERROR] * @param model Model containing the relationship
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\model\SpdxDocument.java:56: error: @param name not found
[ERROR] * @param modelContainer
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\rdfparser\model\SpdxFile.java:745: error: invalid use of @return
[ERROR] * @return
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\spdxspreadsheet\AbstractSpreadsheet.java:48: error: reference not found
[ERROR] * @throws AnalyzeException
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\spdxspreadsheet\AnnotationsSheet.java:134: error: @param name not found
[ERROR] * @param relationship
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\spdxspreadsheet\NonStandardLicensesSheet.java:56: error: @param name not found
[ERROR] * @param optional license name
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\spdxspreadsheet\NonStandardLicensesSheet.java:58: error: @param name not found
[ERROR] * @param optional comment
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\spdxspreadsheet\PackageInfoSheet.java:84: error: @param name not found
[ERROR] * @param rowNum row number of the package
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\tag\HandBuiltParser.java:31: error: unknown tag: text
[ERROR] * if it is in <text> </text>
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\tag\HandBuiltParser.java:31: error: unknown tag: text
[ERROR] * if it is in <text> </text>
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\tag\NoCommentInputStream.java:31: error: unknown tag: text
[ERROR] * if it is within a <text> </text> wrapper
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\tag\NoCommentInputStream.java:31: error: unknown tag: text
[ERROR] * if it is within a <text> </text> wrapper
[ERROR] ^
[ERROR] C:\Users\Ryan\git\spdx-tools\src\org\spdx\tools\SpdxViewer.java:46: error: bad use of '>'
[ERROR] * Usage: PrettyPrinter SPDXRdfXMLFile > textFile where SPDXRdfXMLFile is a
[ERROR] ^
[ERROR] 
[ERROR] Command line was: "C:\Program Files\Java\jdk1.8.0_40\jre\..\bin\javadoc.exe" @options @packages
[ERROR] 
[ERROR] Refer to the generated Javadoc files in 'C:\Users\Ryan\git\spdx-tools\target\apidocs' dir.
[ERROR] -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
romeara commented 9 years ago

This reduces to issues within the files:

org\spdx\compare\AbstractFileCompareSheet.java (7) org\spdx\compare\CompareHelper.java (20) org\spdx\compare\CompareTemplateOutputHandler.java (2) org\spdx\licenseTemplate\ILicenseTemplateOutputHandler.java (5) org\spdx\compare\CreatorSheet.java (8) org\spdx\compare\DocumentAnnotationSheet.java (6) org\spdx\compare\DocumentRelationshipSheet.java (6) org\spdx\compare\DocumentSheet.java (6) org\spdx\compare\ExternalReferencesSheet.java (6) org\spdx\compare\ExtractedLicenseSheet.java (8) org\spdx\compare\FileArtifactOfSheet.java (2) org\spdx\compare\FileChecksumSheet.java (2) org\spdx\compare\FileCommentSheet.java (2) org\spdx\compare\FileConcludedSheet.java (2) org\spdx\compare\FileDependenciesSheet.java (2) org\spdx\compare\FileLicenseCommentsSheet.java (2) org\spdx\compare\FileLicenseInfoSheet.java (2) org\spdx\compare\FileNoticeSheet.java (2) org\spdx\compare\FileTypeSheet.java (2) org\spdx\compare\LicenseCompareHelper.java (8) org\spdx\spdxspreadsheet\AbstractSpreadsheet.java org\spdx\compare\ReviewerSheet.java org\spdx\compare\SpdxPackageComparer.java org\spdx\html\LicenseHTMLFile.java org\spdx\html\PackageContext.java org\spdx\licenseTemplate\HtmlTemplateOutputHandler.java org\spdx\licenseTemplate\SpdxLicenseTemplateHelper.java org\spdx\merge\SpdxPackageInfoMerger.java (2) org\spdx\rdfparser\IModelContainer.java org\spdx\rdfparser\SPDXCreatorInformation.java org\spdx\rdfparser\SPDXDocument.java (3) org\spdx\rdfparser\SPDXFile.java (7) org\spdx\rdfparser\VerificationCodeGenerator.java org\spdx\rdfparser\license\AnyLicenseInfo.java org\spdx\rdfparser\model\IRdfModel.java org\spdx\rdfparser\license\ExtractedLicenseInfo.java org\spdx\rdfparser\license\SimpleLicensingInfo.java (2) org\spdx\rdfparser\license\LicenseException.java (2) org\spdx\rdfparser\license\LicenseInfoFactory.java org\spdx\rdfparser\license\ListedLicenses.java (2) org\spdx\rdfparser\license\OrLaterOperator.java org\spdx\rdfparser\model\RdfModelObject.java (5) org\spdx\rdfparser\model\SpdxElement.java org\spdx\rdfparser\model\Relationship.java org\spdx\rdfparser\model\SpdxDocument.java org\spdx\rdfparser\model\SpdxFile.java org\spdx\spdxspreadsheet\AbstractSpreadsheet.java org\spdx\spdxspreadsheet\AnnotationsSheet.java org\spdx\spdxspreadsheet\NonStandardLicensesSheet.java (2) org\spdx\spdxspreadsheet\PackageInfoSheet.java org\spdx\tag\HandBuiltParser.java (2) org\spdx\tag\NoCommentInputStream.java (2) org\spdx\tools\SpdxViewer.java

goneall commented 9 years ago

Even though the compile error are resolved by pull request #22, I still plan to go through and update the comments incrementally when I am making other changes to the classes

romeara commented 9 years ago

That is my plan as well - I originally intended to actually fix all the comment issues, but I got up to 50 files and decided to instead commit the workaround so the actual fix could be done in a more incremental manner