Skip to content

Add missing package.html files and update outdated links - #923

Open
VolodymyrLinuxovich wants to merge 1 commit into
ESAPI:developfrom
VolodymyrLinuxovich:issue-615
Open

VolodymyrLinuxovich wants to merge 1 commit into
ESAPI:developfrom
VolodymyrLinuxovich:issue-615

Conversation

@VolodymyrLinuxovich

Copy link
Copy Markdown

Closes #615

This adds a package.html to every package under src/main/java that had none. There are 9 of them. The issue named two packages that no longer exist. The log4j logger was removed, so this covers logging.java instead. The cleaner package is now called logging.cleaning.

Each page is a short summary of what the package holds and how its main classes fit together. I checked each one against the code. For logging.java I left out the old esapi-java-logging.properties file because JavaLogFactory now rejects it.

In the org.owasp.esapi package.html I replaced the old owasp.org wiki links with the current project pages. The Sun Java links now go to the Oracle docs, and the dead Microsoft download link now goes to the AntiXSS package on NuGet. I also fixed the ordre typo. I left the text about the project history as it is.

I ran mvn javadoc:javadoc before and after the change. All 9 new pages render. Develop already has 38 Javadoc warnings, and this branch has 37. The one that went away came from the ampersand in the old Microsoft link.

Adds package.html for the 9 packages that had none: codecs.ref,
configuration, configuration.consts, logging.appender, logging.cleaning,
logging.java, logging.slf4j, reference.accesscontrol and
reference.accesscontrol.policyloader.

Updates the dead and redirecting links in the org.owasp.esapi
package.html and fixes the 'ordre' typo.

Fixes ESAPI#615
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create package.html Javadoc files for ESAPI packages where it is missing

1 participant