On 16 July 2014 19:38, Benedikt Ritter <brit...@apache.org> wrote: > Compile and JavaDoc are different things. javac doesn't care for what is > places inside comments (as long as it's a valid UTF-8 character). > > Importing something translates to "I need this to do my work". Clearly a > class doesn't need an exception it is not catching and only importing we > documentation.
+1 > I guess it's the same reason why you don't import java.util.* > > Maybe a matter of aesthetics, I don't know :-) It can be useful to be able to scan code for import statements to see if specific classes are used. For example, are there any references to sun.* packages or crypto code. I agree that imports should only be used when required by the code; never for Javadoc only. > > 2014-07-16 20:18 GMT+02:00 Gary Gregory <garydgreg...@gmail.com>: > >> Compile time and Javadoc time is the same thing IMO. Why does it matter? >> >> Gary >> >> >> On Wed, Jul 16, 2014 at 2:16 PM, Benedikt Ritter <brit...@apache.org> >> wrote: >> >> > So you're introducing a compile dependency to a class just because you >> want >> > to generate documentation? Doesn't sound right to me... My IDE (InetlliJ) >> > automatically generates the FQCN in JavaDocs, if the class has not been >> > imported already. >> > >> > >> > 2014-07-16 20:09 GMT+02:00 Gary Gregory <garydgreg...@gmail.com>: >> > >> > > I disagree with that. Javadocs are already bad enough to write without >> > > having to deal with FQCNs. FWIW, I always used imports. >> > > >> > > Gary >> > > >> > > ---------- Forwarded message ---------- >> > > From: <brit...@apache.org> >> > > Date: Wed, Jul 16, 2014 at 2:05 PM >> > > Subject: svn commit: r1611119 - >> > > >> > > >> > >> /commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryLoader.java >> > > To: comm...@commons.apache.org >> > > >> > > >> > > Author: britter >> > > Date: Wed Jul 16 18:05:42 2014 >> > > New Revision: 1611119 >> > > >> > > URL: http://svn.apache.org/r1611119 >> > > Log: >> > > Use qualified class names instead of importing class just for >> > documentation >> > > >> > > Modified: >> > > >> > > >> > > >> > >> commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryLoader.java >> > > >> > > Modified: >> > > >> > > >> > >> commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryLoader.java >> > > URL: >> > > >> > > >> > >> http://svn.apache.org/viewvc/commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryLoader.java?rev=1611119&r1=1611118&r2=1611119&view=diff >> > > >> > > >> > >> ============================================================================== >> > > --- >> > > >> > > >> > >> commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryLoader.java >> > > (original) >> > > +++ >> > > >> > > >> > >> commons/proper/dbutils/trunk/src/main/java/org/apache/commons/dbutils/QueryLoader.java >> > > Wed Jul 16 18:05:42 2014 >> > > @@ -19,7 +19,6 @@ package org.apache.commons.dbutils; >> > > import java.io.IOException; >> > > import java.io.InputStream; >> > > import java.util.HashMap; >> > > -import java.util.InvalidPropertiesFormatException; >> > > import java.util.Map; >> > > import java.util.Properties; >> > > import java.util.regex.Pattern; >> > > @@ -76,7 +75,7 @@ public class QueryLoader { >> > > * @throws IOException if a file access error occurs >> > > * @throws IllegalArgumentException if the ClassLoader can't find >> a >> > > file at >> > > * the given path. >> > > - * @throws InvalidPropertiesFormatException if the XML properties >> > file >> > > is >> > > + * @throws java.util.InvalidPropertiesFormatException if the XML >> > > properties file is >> > > * invalid >> > > * @return Map of query names to SQL values >> > > * @see java.util.Properties >> > > @@ -103,7 +102,7 @@ public class QueryLoader { >> > > * @throws IOException if a file access error occurs >> > > * @throws IllegalArgumentException if the ClassLoader can't find >> a >> > > file at >> > > * the given path. >> > > - * @throws InvalidPropertiesFormatException if the XML properties >> > file >> > > is >> > > + * @throws java.util.InvalidPropertiesFormatException if the XML >> > > properties file is >> > > * invalid >> > > * @since DbUtils 1.1 >> > > * @return Map of query names to SQL values >> > > >> > > >> > > >> > > >> > > >> > > -- >> > > E-Mail: garydgreg...@gmail.com | ggreg...@apache.org >> > > Java Persistence with Hibernate, Second Edition >> > > <http://www.manning.com/bauer3/> >> > > JUnit in Action, Second Edition <http://www.manning.com/tahchiev/> >> > > Spring Batch in Action <http://www.manning.com/templier/> >> > > Blog: http://garygregory.wordpress.com >> > > Home: http://garygregory.com/ >> > > Tweet! http://twitter.com/GaryGregory >> > > >> > >> > >> > >> > -- >> > http://people.apache.org/~britter/ >> > http://www.systemoutprintln.de/ >> > http://twitter.com/BenediktRitter >> > http://github.com/britter >> > >> >> >> >> -- >> E-Mail: garydgreg...@gmail.com | ggreg...@apache.org >> Java Persistence with Hibernate, Second Edition >> <http://www.manning.com/bauer3/> >> JUnit in Action, Second Edition <http://www.manning.com/tahchiev/> >> Spring Batch in Action <http://www.manning.com/templier/> >> Blog: http://garygregory.wordpress.com >> Home: http://garygregory.com/ >> Tweet! http://twitter.com/GaryGregory >> > > > > -- > http://people.apache.org/~britter/ > http://www.systemoutprintln.de/ > http://twitter.com/BenediktRitter > http://github.com/britter --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org For additional commands, e-mail: dev-h...@commons.apache.org
