[tor-bugs] #21614 [Metrics]: JavaDoc should contain the version number

[Tor Bug Tracker & Wiki]

#21614: JavaDoc should contain the version number
-------------------------+------------------------------
 Reporter:  iwakeh       |          Owner:  metrics-team
     Type:  enhancement  |         Status:  needs_review
 Priority:  Medium       |      Milestone:
Component:  Metrics      |        Version:
 Severity:  Normal       |     Resolution:
 Keywords:               |  Actual Points:
Parent ID:               |         Points:
 Reviewer:               |        Sponsor:
-------------------------+------------------------------

Comment (by karsten):

 How about we add the revision to -dev versions only, but not to released
 versions?  So, "DescripTor 1.6.0 API Documentation" and "DescripTor
 1.6.0-dev 5b1db5d API Documentation"?

 Speaking of, your patch appends the version as in: "DescripTor API
 Documentation 1.6.0-dev", but the version seems a bit out of place there
 at the end.  How about we put together the `doctitle` in `base.xml` by
 using `"${implementation-title} ${release-version} API Documentation"`,
 possibly with the option to override it?  Plus the revision.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/21614#comment:3>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online