[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

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

#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 iwakeh):

 Main headline is fine location, too.
 Additional question is if the revision should be put anywhere?  Thinking
 of people rolling their own versions, but just an idea.

 Regarding the patch (which would also alter the title and only be in
 metrics-lib):
 The version could be appended to the doctitle and be effective for all
 metrics-base using products, e.g., in `base.xml`
 {{{
  <javadoc destdir="${docs}"
              stylesheetfile="${javadocstyle}"
              footer="&amp;copy; ${copyyear} The Tor Project"
 -            doctitle="${javadoc-title}"
 +            doctitle="${javadoc-title} ${release.version}"
              overview="${basedir}/${resources}/overview.html"
              use="true"
              windowtitle="${javadoc-title}">
       <classpath refid="classpath"/>
 }}}

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/21614#comment:2>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs