Bug 1506732
| Summary: | javadoc generation full of correctable errors | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Community] Spacewalk | Reporter: | Eric Herget <eherget> | ||||
| Component: | Documentation | Assignee: | Eric Herget <eherget> | ||||
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Red Hat Satellite QA List <satqe-list> | ||||
| Severity: | unspecified | Docs Contact: | |||||
| Priority: | unspecified | ||||||
| Version: | 2.7 | ||||||
| Target Milestone: | --- | ||||||
| Target Release: | --- | ||||||
| Hardware: | Unspecified | ||||||
| OS: | Unspecified | ||||||
| Whiteboard: | |||||||
| Fixed In Version: | spacewalk-java-2.8.39-1 | Doc Type: | If docs needed, set a value | ||||
| Doc Text: | Story Points: | --- | |||||
| Clone Of: | Environment: | ||||||
| Last Closed: | 2018-04-20 12:31:32 UTC | Type: | Bug | ||||
| Regression: | --- | Mount Type: | --- | ||||
| Documentation: | --- | CRM: | |||||
| Verified Versions: | Category: | --- | |||||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |||||
| Cloudforms Team: | --- | Target Upstream Version: | |||||
| Embargoed: | |||||||
| Bug Depends On: | |||||||
| Bug Blocks: | 1564160 | ||||||
| Attachments: |
|
||||||
Many of the errors that result in missing content in the generated javadoc may be fixed with simple use of {@literal _text_} surrounding problem content.
Reference not found, and package does not exist errors can likely be fixed with updated classpath when running javadoc command.
Fixed 265 files. Also updated the documentation/Makefile to add javadoc command line args to ignore tags used for api docs generation. As I check this in, there are no errors when generating javadoc documentation. I will update the Release Procedure document to include cleaning up all javadoc error messages when generating docs for a release. spacewalk.github: 1299868891ddfaaf8fe5a255484fd9bf4cdcb6b1 d058f79cc73f046e29e0d1082f2a365b9e3844d2 Moving ON_QA Spacewalk 2.8 has been released. https://github.com/spacewalkproject/spacewalk/wiki/ReleaseNotes28 |
Created attachment 1343860 [details] Javadoc generation errors Description of problem: When generating the javadoc as part of the release process, there are numerous errors reported that could be corrected. Some of these result in missing information in the generated javadoc. Version-Release number of selected component (if applicable): Latest release How reproducible: Always Steps to Reproduce: 1. follow the Javadoc generation steps in spacewalk/documentation/how-to-generate-documentation.txt 2. see the errors reported in the output (copy of which is attached) 3. where error is, for example, "unknown tag", check the corresponding page and find that text intended for the javadoc is missing. Actual results: Numerous errors when generating javadoc Expected results: No errors and desired content in the generated docs Additional info: See attached javadoc-output.txt for the list of errors from a recent javadoc run Document URL: Section Number and Name: Describe the issue: Suggestions for improvement: Additional information: