Opened 3 years ago

Closed 3 years ago

#21469 closed enhancement (fixed)

Exclude index package from Javadocs

Reported by: karsten Owned by: metrics-team
Priority: Medium Milestone: metrics-lib 1.6.0
Component: Metrics/Library Version:
Severity: Normal Keywords:
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

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?

Child Tickets

Change History (2)

comment:1 Changed 3 years ago by iwakeh

Status: newneeds_review

I'd suggest a small change in metrics-base, which enables a more fine grained way of excluding from javadoc.

Please review, if this works as expected.

comment:2 Changed 3 years ago by karsten

Resolution: fixed
Status: needs_reviewclosed

Works great, merged! Closing. Thanks!

Note: See TracTickets for help on using tickets.