garydgregory commented on code in PR #103:
URL:
https://github.com/apache/commons-secure-xml/pull/103#discussion_r4093439967
##########
src/main/javadoc/overview.html:
##########
@@ -526,6 +526,69 @@ <h1>
href="../threat_model.html">Threat Model</a> documents the resulting
contract.
</p>
</section>
+ <section id="jaxb">
+ <h1>
+ <img src="org/apache/commons/xml/secure/doc-files/leaf.svg"
style="height: 1em; padding-right: 0.25em" alt="leaf">Migrating JAXB
Review Comment:
Hm, there is no website documentation, intentionally; the only site level
docs we have point to various places in the Javadoc, like this file. All the
documentation is meant to be here, in the `overview.html`, and the rest of the
Javadoc where needed. This allows this documentation to always match the code
for a given release. IMO, the Javadoc is the first source of truth because it
is closest to the code. The site can have extra stuff, but not duplication
hopefully. For example, the site can have errata for old documentation.
I guess what I'm saying is that I plan on maintaining the Javadoc but if you
want to duplicate this information on the site, I'll leave it you it up to you
to maintain that ;)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
