[metrics-bugs] #21469 [Metrics/metrics-lib]: Exclude index package from Javadocs

Tor Bug Tracker & Wiki blackhole at torproject.org
Wed Feb 15 10:40:03 UTC 2017

#21469: Exclude index package from Javadocs
     Reporter:  karsten              |      Owner:  metrics-team
         Type:  enhancement          |     Status:  new
     Priority:  Medium               |  Milestone:  metrics-lib 1.6.0
    Component:  Metrics/metrics-lib  |    Version:
     Severity:  Normal               |   Keywords:
Actual Points:                       |  Parent ID:
       Points:                       |   Reviewer:
      Sponsor:                       |
 I just found that we're not excluding the index package from generated
 Javadocs, though the classes there are not part of the API but part of the
 implementation.  We should exclude that package just like we exclude the
 impl package.  Dirty patch:

 diff --git a/build.xml b/build.xml
 index a870eca..136c15b 100644
 --- a/build.xml
 +++ b/build.xml
 @@ -8,7 +8,7 @@

    <property name="release.version" value="1.5.0-dev" />
    <property name="javadoc-title" value="DescripTor API Documentation"/>
 -  <property name="javadoc-excludes" value="**/impl/**" />
 +  <property name="javadoc-excludes" value="**/i*/**" />
    <property name="implementation-title" value="DescripTor" />
    <property name="name" value="descriptor" />
    <property name="jarpatternprop" value="empty" />

 Maybe there's a better way to achieve this?

Ticket URL: <https://trac.torproject.org/projects/tor/ticket/21469>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online

More information about the metrics-bugs mailing list