commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gary Gregory <garydgreg...@gmail.com>
Subject RE: [compress] exclude _internal package from javadocs?
Date Sun, 12 Jan 2014 13:34:42 GMT
I think I would leave it in. 

Would it not be helpful to people trying to understand the code?

We could also generically hide or _color_ differently this kind of package from the parent
POM.

Gary

-------- Original message --------
From: Stefan Bodewig <bodewig@apache.org> 
Date:01/12/2014  05:18  (GMT-05:00) 
To: dev@commons.apache.org 
Subject: [compress] exclude _internal package from javadocs? 

Compress holds a package that is public as an implementation detail but
whose API isn't meant for public consumption.  The javadocs of said
package state this in bold letters.[1]

Current trunk will even go further and hide the package from javadoc,
but the only class inside is still refered to by two stream classes that
inherit from it (ZCompressorInputStream and UnshrinkingInputStream).

I'm a bit torn on this and since I'll re-roll a new RC anyway I'd like
to see what others think about hiding internal packages.

Stefan

[1] http://people.apache.org/~bodewig/cc-1.7/apidocs/org/apache/commons/compress/compressors/z/_internal_/package-summary.html

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message