Document Maven Dependencies

Question

I would like to provide a rationale for choosing a specific dependency in my project (in this case why I chose a particular language-detection library), so am wondering if I can do this in the dependency report section of the site? I looked at the definition of the dependency element in the pom reference but there does not seem to be a way to attach any documentation to is.

Does anyone have a good way of documenting such decisions? I would like to put it into the dependencies report if possible as this is where people might reasonably look for it.

Answer 1

I would add it as XML-comment next to the specific dependency. If you want to explain your choices with a report, just create your own page. The dependency-report has no space for it.