[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:
-------------------------+------------------------------
Changes (by karsten):

 * status:  new => needs_review


Comment:

 Or how about we add the version number to the `<h1>`, as in "DescripTor
 1.6.0 API Documentation"?  That's something that a few random other
 JavaDocs do that I just found on the internet.  Patch:

 {{{
 diff --git a/build.xml b/build.xml
 index fb926c2..1133fe6 100644
 --- a/build.xml
 +++ b/build.xml
 @@ -7,7 +7,7 @@
  <project default="usage" name="descriptor" basedir=".">

    <property name="release.version" value="1.6.0-dev" />
 -  <property name="javadoc-title" value="DescripTor API Documentation"/>
 +  <property name="javadoc-title" value="DescripTor ${release.version} API
 Documentation"/>
    <property name="javadoc-excludes" value="**/impl/** **/index/**" />
    <property name="implementation-title" value="DescripTor" />
    <property name="name" value="descriptor" />
 }}}

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/21614#comment:1>
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