docs: Update list of supported report formats#6224
Merged
jeremylong merged 1 commit intodependency-check:mainfrom Dec 5, 2023
Inform-Software:all-formats
Merged
docs: Update list of supported report formats#6224jeremylong merged 1 commit intodependency-check:mainfrom Inform-Software:all-formats
jeremylong merged 1 commit intodependency-check:mainfrom
Inform-Software:all-formats
Conversation
boring-cyborg
Bot
added
ant
TobiX
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes Issue #6194
Description of Change
This updates all lists of supported report formats in documentation and Javadoc to the content of
ReportGenerator.Formats. If there are other spurious changes to the lists: I just took one list, added the missing formats and copied that everywhere, overwriting whatever is there. In Javadoc comments where it was reasonable to assume that the user might have a Javdoc browser available, I replaced the list with a link to the enum.As a future improvement it might be a good idea to define a canonical order and always list reports in that order (maybe the same as the enum?).
Additionally, I moved one log message around, so the list of formats is discoverable by requesting "ALL" formats: Each log line now shows which format is written.
Have test cases been added to cover the new functionality?
no