Changeset 6041


Ignore:
Timestamp:
03/18/10 13:18:24 (10 years ago)
Author:
curtis
Message:

Some Javadoc cleanup and additions.

Location:
trunk
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • trunk/ant/toplevel.properties

    r6027 r6041  
    1515                        ${lib.dir}/Ice-3.3.1.jar:\ 
    1616                        ${lib.dir}/checkstyle-all-5.0.jar:\ 
     17                        ${lib.dir}/clibwrapper_jiio.jar:\ 
    1718                        ${lib.dir}/forms-1.3.0.jar:\ 
    1819                        ${lib.dir}/ij.jar:\ 
  • trunk/components/bio-formats/src/loci/formats/MetadataTools.java

    r6040 r6041  
    257257  } 
    258258 
    259   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     259  /** 
     260   * @deprecated This method is not thread-safe; use 
     261   * {@link loci.formats.services.OMEXMLService#getLatestVersion()} 
     262   * instead. 
     263   */ 
    260264  public static String getLatestVersion() { 
    261265    if (omexmlService == null) return null; 
     
    263267  } 
    264268 
    265   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     269  /** 
     270   * @deprecated This method is not thread-safe; use 
     271   * {@link loci.formats.services.OMEXMLService#createOMEXMLMetadata()} 
     272   * instead. 
     273   */ 
    266274  public static IMetadata createOMEXMLMetadata() { 
    267275    if (omexmlService == null) return null; 
     
    274282  } 
    275283 
    276   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     284  /** 
     285   * @deprecated This method is not thread-safe; use 
     286   * {@link loci.formats.services.OMEXMLService#createOMEXMLMetadata(String)} 
     287   * instead. 
     288   */ 
    277289  public static IMetadata createOMEXMLMetadata(String xml) { 
    278290    if (omexmlService == null) return null; 
     
    285297  } 
    286298 
    287   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     299  /** 
     300   * @deprecated This method is not thread-safe; use 
     301   * {@link loci.formats.services.OMEXMLService#createOMEXMLMetadata(String, 
     302   *   String)} 
     303   * instead. 
     304   */ 
    288305  public static IMetadata createOMEXMLMetadata(String xml, String version) { 
    289306    if (omexmlService == null) return null; 
     
    296313  } 
    297314 
    298   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     315  /** 
     316   * @deprecated This method is not thread-safe; use 
     317   * {@link loci.formats.services.OMEXMLService#createOMEXMLRoot(String)} 
     318   * instead. 
     319   */ 
    299320  public static Object createOMEXMLRoot(String xml) { 
    300321    if (omexmlService == null) return null; 
     
    307328  } 
    308329 
    309   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     330  /** 
     331   * @deprecated This method is not thread-safe; use 
     332   * {@link loci.formats.services.OMEXMLService#isOMEXMLMetadata(Object)} 
     333   * instead. 
     334   */ 
    310335  public static boolean isOMEXMLMetadata(Object o) { 
    311336    if (omexmlService == null) return false; 
     
    313338  } 
    314339 
    315   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     340  /** 
     341   * @deprecated This method is not thread-safe; use 
     342   * {@link loci.formats.services.OMEXMLService#isOMEXMLRoot(Object)} 
     343   * instead. 
     344   */ 
    316345  public static boolean isOMEXMLRoot(Object o) { 
    317346    if (omexmlService == null) return false; 
     
    319348  } 
    320349 
    321   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     350  /** 
     351   * @deprecated This method is not thread-safe; use 
     352   * {@link loci.formats.services.OMEXMLService#getOMEXMLVersion(Object)} 
     353   * instead. 
     354   */ 
    322355  public static String getOMEXMLVersion(Object o) { 
    323356    if (omexmlService == null) return null; 
     
    325358  } 
    326359 
    327   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     360  /** 
     361   * @deprecated This method is not thread-safe; use 
     362   * {@link loci.formats.services.OMEXMLService#getOMEMetadata(MetadataRetrieve)} 
     363   * instead. 
     364   */ 
    328365  public static IMetadata getOMEMetadata(MetadataRetrieve src) { 
    329366    if (omexmlService == null) return null; 
     
    336373  } 
    337374 
    338   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     375  /** 
     376   * @deprecated This method is not thread-safe; use 
     377   * {@link loci.formats.services.OMEXMLService#getOMEXML(MetadataRetrieve)} 
     378   * instead. 
     379   */ 
    339380  public static String getOMEXML(MetadataRetrieve src) { 
    340381    if (omexmlService == null) return null; 
     
    347388  } 
    348389 
    349   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     390  /** 
     391   * @deprecated This method is not thread-safe; use 
     392   * {@link loci.formats.services.OMEXMLService#validateOMEXML(String)} 
     393   * instead. 
     394   */ 
    350395  public static boolean validateOMEXML(String xml) { 
    351396    if (omexmlService == null) return false; 
     
    353398  } 
    354399 
    355   /** @deprecated @see loci.formats.services.OMEXMLService */ 
     400  /** 
     401   * @deprecated This method is not thread-safe; use 
     402   * {@link loci.formats.services.OMEXMLService#validateOMEXML(String, boolean)} 
     403   * instead. 
     404   */ 
    356405  public static boolean validateOMEXML(String xml, boolean pixelsHack) { 
    357406    if (omexmlService == null) return false; 
  • trunk/components/bio-formats/src/loci/formats/enums/IEnumerationProvider.java

    r6026 r6041  
    4040   * the latest OME-XML schema version.  If no enumeration corresponds to the 
    4141   * given value, null is returned. 
    42    * 
    43    * @param enumerations List of enumerations for this type. 
    4442   */ 
    4543  <T extends Enumeration> T getEnumeration(Class<T> type, String value) 
  • trunk/components/bio-formats/src/loci/formats/services/MDBService.java

    r6026 r6041  
    4040  /** 
    4141   * Prepare the given .mdb file for reading.  This method must be called 
    42    * before {@link parseDatabase()}. 
     42   * before {@link #parseDatabase()}. 
    4343   * 
    4444   * @throws IOException if a problem occurs when opening the file 
     
    5555   * The first entry in the column name row is the name of the table. 
    5656   * 
    57    * {@link initialize(String)} must be called before calling parseDatabase(). 
     57   * {@link #initialize(String)} must be called before calling parseDatabase(). 
    5858   * 
    5959   * @throws IOException if there is a problem reading the table data 
  • trunk/components/common/src/loci/common/CBZip2InputStream.java

    r6026 r6041  
    6060 * should call the {@link #close() close()} method as soon as 
    6161 * possible, to force <tt>CBZip2InputStream</tt> to release the 
    62  * allocated memory.  See {@link CBZip2OutputStream 
    63  * CBZip2OutputStream} for information about memory usage.</p> 
     62 * allocated memory.  See <tt>CBZip2OutputStream</tt> 
     63 * for information about memory usage.</p> 
    6464 * 
    6565 * <p><tt>CBZip2InputStream</tt> reads bytes from the compressed 
  • trunk/components/common/src/loci/common/Location.java

    r6026 r6041  
    284284   * disk (i.e. is not a URL). 
    285285   * 
    286    * @returns true if the file was created successfully 
     286   * @return true if the file was created successfully 
    287287   * @throws IOException if an I/O error occurred, or the 
    288288   *   abstract pathname is a URL 
     
    295295 
    296296  /** 
    297    * Deletes this file.  If {@link isDirectory()} returns true, then the 
     297   * Deletes this file.  If {@link #isDirectory()} returns true, then the 
    298298   * directory must be empty in order to be deleted.  URLs cannot be deleted. 
    299299   * 
    300    * @returns true if the file was successfully deleted 
     300   * @return true if the file was successfully deleted 
    301301   * @see java.io.File#delete() 
    302302   */ 
     
    362362   * Returns the canonical path to this file. 
    363363   * If the file is a URL, then the canonical path is equivalent to the 
    364    * absolute path ({@link getAbsolutePath()}).  Otherwise, this method 
     364   * absolute path ({@link #getAbsolutePath()}).  Otherwise, this method 
    365365   * will delegate to {@link java.io.File#getCanonicalPath()}. 
    366366   */ 
  • trunk/components/common/src/loci/common/NIOInputStream.java

    r6026 r6041  
    150150   * Reads a string ending with one of the characters in the given string. 
    151151   * 
    152    * @see #findString(String) 
     152   * @see #findString(String...) 
    153153   */ 
    154154  public String readString(String lastChars) throws IOException { 
  • trunk/components/common/src/loci/common/services/ServiceFactory.java

    r6026 r6041  
    4242 * <dd><a href="https://skyking.microscopy.wisc.edu/trac/java/browser/trunk/components/bio-formats/src/loci/formats/in/ServiceFactory.java">Trac</a>, 
    4343 * <a href="https://skyking.microscopy.wisc.edu/svn/java/trunk/components/bio-formats/src/loci/formats/in/ServiceFactory.java">SVN</a></dd></dl> 
    44  * @param <T> 
    4544 */ 
    4645public class ServiceFactory { 
     
    5453 
    5554  /** Constructor cache. */ 
    56   private static Map<Class<? extends Service>, Constructor<? extends Service>>  
    57     constructorCache =  
     55  private static Map<Class<? extends Service>, Constructor<? extends Service>> 
     56    constructorCache = 
    5857      new HashMap<Class<? extends Service>, Constructor<? extends Service>>(); 
    59    
     58 
    6059  /** Set of available services. */ 
    6160  private Map<Class<? extends Service>, Class<? extends Service>> 
     
    117116          interfaceClass, implementationClass); 
    118117    } 
    119      
     118 
    120119  } 
    121120 
     
    147146 
    148147  /** 
    149    * Retrieves a constructor for a given class from the constructor cache if  
     148   * Retrieves a constructor for a given class from the constructor cache if 
    150149   * possible. 
    151150   * @param klass Class to retrieve a constructor for. 
Note: See TracChangeset for help on using the changeset viewer.