Changeset 7128


Ignore:
Timestamp:
10/25/10 16:20:32 (9 years ago)
Author:
melissa
Message:

Fixed a handful of Javadoc errors.

Files:
4 edited

Legend:

Unmodified
Added
Removed
  • branches/4.2/components/bio-formats/src/loci/formats/services/OMEXMLServiceImpl.java

    r7103 r7128  
    113113  } 
    114114 
    115   /* (non-Javadoc) 
    116    * @see loci.formats.services.OMEXMLService#getLatestVersion() 
    117    */ 
     115  /** @see OMEXMLService#getLatestVersion() */ 
    118116  public String getLatestVersion() { 
    119117    return OMEXMLFactory.LATEST_VERSION; 
    120118  } 
    121119 
    122   /* @see OMEXMLService#transformToLatestVersion(String) */ 
     120  /** @see OMEXMLService#transformToLatestVersion(String) */ 
    123121  public String transformToLatestVersion(String xml) throws ServiceException { 
    124122    String version = getOMEXMLVersion(xml); 
     
    177175  } 
    178176 
    179   /* (non-Javadoc) 
    180    * @see loci.formats.ome.OMEXMLService#createOMEXMLMetadata() 
    181    */ 
     177  /** @see OMEXMLService#createOMEXMLMetadata() */ 
    182178  public OMEXMLMetadata createOMEXMLMetadata() throws ServiceException { 
    183179    return createOMEXMLMetadata(null); 
    184180  } 
    185181 
    186   /* (non-Javadoc) 
    187    * @see loci.formats.ome.OMEXMLService#createOMEXMLMetadata(java.lang.String) 
    188    */ 
     182  /** @see OMEXMLService#createOMEXMLMetadata(java.lang.String) */ 
    189183  public OMEXMLMetadata createOMEXMLMetadata(String xml) 
    190184    throws ServiceException { 
     
    192186  } 
    193187 
    194   /* (non-Javadoc) 
    195    * @see loci.formats.ome.OMEXMLService#createOMEXMLMetadata(java.lang.String, java.lang.String) 
     188  /** 
     189   * @see OMEXMLService#createOMEXMLMetadata(java.lang.String, java.lang.String) 
    196190   */ 
    197191  public OMEXMLMetadata createOMEXMLMetadata(String xml, String version) 
     
    205199  } 
    206200 
    207   /* (non-Javadoc) 
    208    * @see loci.formats.ome.OMEXMLService#createOMEXMLRoot(java.lang.String) 
    209    */ 
     201  /** @see OMEXMLService#createOMEXMLRoot(java.lang.String) */ 
    210202  public Object createOMEXMLRoot(String xml) throws ServiceException { 
    211203    return createRoot(transformToLatestVersion(xml)); 
    212204  } 
    213205 
    214   /* (non-Javadoc) 
    215    * @see loci.formats.ome.OMEXMLService#isOMEXMLMetadata(java.lang.Object) 
    216    */ 
     206  /** @see OMEXMLService#isOMEXMLMetadata(java.lang.Object) */ 
    217207  public boolean isOMEXMLMetadata(Object o) { 
    218208    return o instanceof OMEXMLMetadata; 
    219209  } 
    220210 
    221   /* (non-Javadoc) 
    222    * @see loci.formats.ome.OMEXMLService#isOMEXMLRoot(java.lang.Object) 
    223    */ 
     211  /** @see OMEXMLService#isOMEXMLRoot(java.lang.Object) */ 
    224212  public boolean isOMEXMLRoot(Object o) { 
    225213    return o instanceof OMEModelObject; 
     
    249237  } 
    250238 
    251   /* (non-Javadoc) 
    252    * @see loci.formats.ome.OMEXMLService#getOMEXMLVersion(java.lang.Object) 
    253    */ 
     239  /** @see OMEXMLService#getOMEXMLVersion(java.lang.Object) */ 
    254240  public String getOMEXMLVersion(Object o) { 
    255241    if (o == null) return null; 
     
    275261  } 
    276262 
    277   /* (non-Javadoc) 
    278    * @see loci.formats.ome.OMEXMLService#getOMEMetadata(loci.formats.meta.MetadataRetrieve) 
    279    */ 
     263  /** @see OMEXMLService#getOMEMetadata(loci.formats.meta.MetadataRetrieve) */ 
    280264  public OMEXMLMetadata getOMEMetadata(MetadataRetrieve src) 
    281265    throws ServiceException { 
     
    290274  } 
    291275 
    292   /* (non-Javadoc) 
    293    * @see loci.formats.ome.OMEXMLService#getOMEXML(loci.formats.meta.MetadataRetrieve) 
    294    */ 
     276  /** @see OMEXMLService#getOMEXML(loci.formats.meta.MetadataRetrieve) */ 
    295277  public String getOMEXML(MetadataRetrieve src) throws ServiceException { 
    296278    OMEXMLMetadata omexmlMeta = getOMEMetadata(src); 
     
    298280  } 
    299281 
    300   /* (non-Javadoc) 
    301    * @see loci.formats.ome.OMEXMLService#validateOMEXML(java.lang.String) 
    302    */ 
     282  /** @see OMEXMLService#validateOMEXML(java.lang.String) */ 
    303283  public boolean validateOMEXML(String xml) { 
    304284    return validateOMEXML(xml, false); 
    305285  } 
    306286 
    307   /* (non-Javadoc) 
    308    * @see loci.formats.ome.OMEXMLService#validateOMEXML(java.lang.String, boolean) 
    309    */ 
     287  /** @see OMEXMLService#validateOMEXML(java.lang.String, boolean) */ 
    310288  public boolean validateOMEXML(String xml, boolean pixelsHack) { 
    311289    // HACK: Inject a TiffData element beneath any childless Pixels elements. 
     
    361339 
    362340  /** 
    363    * @see loci.formats.ome.OMEXMLService#populateOriginalMetadata(loci.formats.ome.OMEXMLMetadata, Hashtable<String, Object>) 
     341   * @see OMEXMLService#populateOriginalMetadata(loci.formats.ome.OMEXMLMetadata, Hashtable) 
    364342   */ 
    365343  public void populateOriginalMetadata(OMEXMLMetadata omexmlMeta, 
     
    384362  } 
    385363 
    386   /* (non-Javadoc) 
    387    * @see loci.formats.ome.OMEXMLService#populateOriginalMetadata(loci.formats.ome.OMEXMLMetadata, java.lang.String, java.lang.String) 
     364  /** 
     365   * @see OMEXMLService#populateOriginalMetadata(loci.formats.ome.OMEXMLMetadata, java.lang.String, java.lang.String) 
    388366   */ 
    389367  public void populateOriginalMetadata(OMEXMLMetadata omexmlMeta, 
     
    405383  } 
    406384 
    407   /* (non-Javadoc) 
    408    * @see loci.formats.ome.OMEXMLService#convertMetadata(java.lang.String, loci.formats.meta.MetadataStore) 
     385  /** 
     386   * @see OMEXMLService#convertMetadata(java.lang.String, loci.formats.meta.MetadataStore) 
    409387   */ 
    410388  public void convertMetadata(String xml, MetadataStore dest) 
     
    431409  } 
    432410 
    433   /* (non-Javadoc) 
    434    * @see loci.formats.ome.OMEXMLService#convertMetadata(loci.formats.meta.MetadataRetrieve, loci.formats.meta.MetadataStore) 
     411  /** 
     412   * @see OMEXMLService#convertMetadata(loci.formats.meta.MetadataRetrieve, loci.formats.meta.MetadataStore) 
    435413   */ 
    436414  public void convertMetadata(MetadataRetrieve src, MetadataStore dest) { 
     
    438416  } 
    439417 
    440   /* @see OMEXMLService#removeBinData(OMEXMLMetadata) */ 
     418  /** @see OMEXMLService#removeBinData(OMEXMLMetadata) */ 
    441419  public void removeBinData(OMEXMLMetadata omexmlMeta) { 
    442420    OME root = (OME) omexmlMeta.getRoot(); 
     
    452430  } 
    453431 
    454   /* @see OMEXMLService#addMetadataOnly(OMEXMLMetadata, int) */ 
     432  /** @see OMEXMLService#addMetadataOnly(OMEXMLMetadata, int) */ 
    455433  public void addMetadataOnly(OMEXMLMetadata omexmlMeta, int image) { 
    456434    MetadataOnly meta = new MetadataOnly(); 
     
    463441  // -- Utility methods - casting -- 
    464442 
    465   /* (non-Javadoc) 
    466    * @see loci.formats.ome.OMEXMLService#asStore(loci.formats.meta.MetadataRetrieve) 
    467    */ 
     443  /** @see OMEXMLService#asStore(loci.formats.meta.MetadataRetrieve) */ 
    468444  public MetadataStore asStore(MetadataRetrieve meta) { 
    469445    return meta instanceof MetadataStore ? (MetadataStore) meta : null; 
    470446  } 
    471447 
    472   /* (non-Javadoc) 
    473    * @see loci.formats.ome.OMEXMLService#asRetrieve(loci.formats.meta.MetadataStore) 
    474    */ 
     448  /** @see OMEXMLService#asRetrieve(loci.formats.meta.MetadataStore) */ 
    475449  public MetadataRetrieve asRetrieve(MetadataStore meta) { 
    476450    return meta instanceof MetadataRetrieve ? (MetadataRetrieve) meta : null; 
  • branches/4.2/components/test-suite/src/loci/tests/ImageTester.java

    r7007 r7128  
    5353 
    5454/** 
    55  * A class for testing the {@link loci.formats.AWTImageTools#makeImage} methods. 
     55 * A class for testing the {@link loci.formats.gui.AWTImageTools#makeImage} 
     56 * methods. 
    5657 * 
    5758 * <dl><dt><b>Source code:</b></dt> 
  • trunk/components/bio-formats/src/loci/formats/services/OMEXMLServiceImpl.java

    r7068 r7128  
    113113  } 
    114114 
    115   /* (non-Javadoc) 
    116    * @see loci.formats.services.OMEXMLService#getLatestVersion() 
    117    */ 
     115  /** @see OMEXMLService#getLatestVersion() */ 
    118116  public String getLatestVersion() { 
    119117    return OMEXMLFactory.LATEST_VERSION; 
    120118  } 
    121119 
    122   /* @see OMEXMLService#transformToLatestVersion(String) */ 
     120  /** @see OMEXMLService#transformToLatestVersion(String) */ 
    123121  public String transformToLatestVersion(String xml) throws ServiceException { 
    124122    String version = getOMEXMLVersion(xml); 
     
    177175  } 
    178176 
    179   /* (non-Javadoc) 
    180    * @see loci.formats.ome.OMEXMLService#createOMEXMLMetadata() 
    181    */ 
     177  /** @see OMEXMLService#createOMEXMLMetadata() */ 
    182178  public OMEXMLMetadata createOMEXMLMetadata() throws ServiceException { 
    183179    return createOMEXMLMetadata(null); 
    184180  } 
    185181 
    186   /* (non-Javadoc) 
    187    * @see loci.formats.ome.OMEXMLService#createOMEXMLMetadata(java.lang.String) 
    188    */ 
     182  /** @see OMEXMLService#createOMEXMLMetadata(java.lang.String) */ 
    189183  public OMEXMLMetadata createOMEXMLMetadata(String xml) 
    190184    throws ServiceException { 
     
    192186  } 
    193187 
    194   /* (non-Javadoc) 
    195    * @see loci.formats.ome.OMEXMLService#createOMEXMLMetadata(java.lang.String, java.lang.String) 
     188  /** 
     189   * @see OMEXMLService#createOMEXMLMetadata(java.lang.String, java.lang.String) 
    196190   */ 
    197191  public OMEXMLMetadata createOMEXMLMetadata(String xml, String version) 
     
    205199  } 
    206200 
    207   /* (non-Javadoc) 
    208    * @see loci.formats.ome.OMEXMLService#createOMEXMLRoot(java.lang.String) 
    209    */ 
     201  /** @see OMEXMLService#createOMEXMLRoot(java.lang.String) */ 
    210202  public Object createOMEXMLRoot(String xml) throws ServiceException { 
    211203    return createRoot(transformToLatestVersion(xml)); 
    212204  } 
    213205 
    214   /* (non-Javadoc) 
    215    * @see loci.formats.ome.OMEXMLService#isOMEXMLMetadata(java.lang.Object) 
    216    */ 
     206  /** @see OMEXMLService#isOMEXMLMetadata(java.lang.Object) */ 
    217207  public boolean isOMEXMLMetadata(Object o) { 
    218208    return o instanceof OMEXMLMetadata; 
    219209  } 
    220210 
    221   /* (non-Javadoc) 
    222    * @see loci.formats.ome.OMEXMLService#isOMEXMLRoot(java.lang.Object) 
    223    */ 
     211  /** @see OMEXMLService#isOMEXMLRoot(java.lang.Object) */ 
    224212  public boolean isOMEXMLRoot(Object o) { 
    225213    return o instanceof OMEModelObject; 
     
    249237  } 
    250238 
    251   /* (non-Javadoc) 
    252    * @see loci.formats.ome.OMEXMLService#getOMEXMLVersion(java.lang.Object) 
    253    */ 
     239  /** @see OMEXMLService#getOMEXMLVersion(java.lang.Object) */ 
    254240  public String getOMEXMLVersion(Object o) { 
    255241    if (o == null) return null; 
     
    275261  } 
    276262 
    277   /* (non-Javadoc) 
    278    * @see loci.formats.ome.OMEXMLService#getOMEMetadata(loci.formats.meta.MetadataRetrieve) 
    279    */ 
     263  /** @see OMEXMLService#getOMEMetadata(loci.formats.meta.MetadataRetrieve) */ 
    280264  public OMEXMLMetadata getOMEMetadata(MetadataRetrieve src) 
    281265    throws ServiceException { 
     
    290274  } 
    291275 
    292   /* (non-Javadoc) 
    293    * @see loci.formats.ome.OMEXMLService#getOMEXML(loci.formats.meta.MetadataRetrieve) 
    294    */ 
     276  /** @see OMEXMLService#getOMEXML(loci.formats.meta.MetadataRetrieve) */ 
    295277  public String getOMEXML(MetadataRetrieve src) throws ServiceException { 
    296278    OMEXMLMetadata omexmlMeta = getOMEMetadata(src); 
     
    298280  } 
    299281 
    300   /* (non-Javadoc) 
    301    * @see loci.formats.ome.OMEXMLService#validateOMEXML(java.lang.String) 
    302    */ 
     282  /** @see OMEXMLService#validateOMEXML(java.lang.String) */ 
    303283  public boolean validateOMEXML(String xml) { 
    304284    return validateOMEXML(xml, false); 
    305285  } 
    306286 
    307   /* (non-Javadoc) 
    308    * @see loci.formats.ome.OMEXMLService#validateOMEXML(java.lang.String, boolean) 
    309    */ 
     287  /** @see OMEXMLService#validateOMEXML(java.lang.String, boolean) */ 
    310288  public boolean validateOMEXML(String xml, boolean pixelsHack) { 
    311289    // HACK: Inject a TiffData element beneath any childless Pixels elements. 
     
    361339 
    362340  /** 
    363    * @see loci.formats.ome.OMEXMLService#populateOriginalMetadata(loci.formats.ome.OMEXMLMetadata, Hashtable<String, Object>) 
     341   * @see OMEXMLService#populateOriginalMetadata(loci.formats.ome.OMEXMLMetadata, Hashtable) 
    364342   */ 
    365343  public void populateOriginalMetadata(OMEXMLMetadata omexmlMeta, 
     
    384362  } 
    385363 
    386   /* (non-Javadoc) 
    387    * @see loci.formats.ome.OMEXMLService#populateOriginalMetadata(loci.formats.ome.OMEXMLMetadata, java.lang.String, java.lang.String) 
     364  /** 
     365   * @see OMEXMLService#populateOriginalMetadata(loci.formats.ome.OMEXMLMetadata, java.lang.String, java.lang.String) 
    388366   */ 
    389367  public void populateOriginalMetadata(OMEXMLMetadata omexmlMeta, 
     
    405383  } 
    406384 
    407   /* (non-Javadoc) 
    408    * @see loci.formats.ome.OMEXMLService#convertMetadata(java.lang.String, loci.formats.meta.MetadataStore) 
     385  /** 
     386   * @see OMEXMLService#convertMetadata(java.lang.String, loci.formats.meta.MetadataStore) 
    409387   */ 
    410388  public void convertMetadata(String xml, MetadataStore dest) 
     
    431409  } 
    432410 
    433   /* (non-Javadoc) 
    434    * @see loci.formats.ome.OMEXMLService#convertMetadata(loci.formats.meta.MetadataRetrieve, loci.formats.meta.MetadataStore) 
     411  /** 
     412   * @see OMEXMLService#convertMetadata(loci.formats.meta.MetadataRetrieve, loci.formats.meta.MetadataStore) 
    435413   */ 
    436414  public void convertMetadata(MetadataRetrieve src, MetadataStore dest) { 
     
    438416  } 
    439417 
    440   /* @see OMEXMLService#removeBinData(OMEXMLMetadata) */ 
     418  /** @see OMEXMLService#removeBinData(OMEXMLMetadata) */ 
    441419  public void removeBinData(OMEXMLMetadata omexmlMeta) { 
    442420    OME root = (OME) omexmlMeta.getRoot(); 
     
    452430  } 
    453431 
    454   /* @see OMEXMLService#addMetadataOnly(OMEXMLMetadata, int) */ 
     432  /** @see OMEXMLService#addMetadataOnly(OMEXMLMetadata, int) */ 
    455433  public void addMetadataOnly(OMEXMLMetadata omexmlMeta, int image) { 
    456434    MetadataOnly meta = new MetadataOnly(); 
     
    463441  // -- Utility methods - casting -- 
    464442 
    465   /* (non-Javadoc) 
    466    * @see loci.formats.ome.OMEXMLService#asStore(loci.formats.meta.MetadataRetrieve) 
    467    */ 
     443  /** @see OMEXMLService#asStore(loci.formats.meta.MetadataRetrieve) */ 
    468444  public MetadataStore asStore(MetadataRetrieve meta) { 
    469445    return meta instanceof MetadataStore ? (MetadataStore) meta : null; 
    470446  } 
    471447 
    472   /* (non-Javadoc) 
    473    * @see loci.formats.ome.OMEXMLService#asRetrieve(loci.formats.meta.MetadataStore) 
    474    */ 
     448  /** @see OMEXMLService#asRetrieve(loci.formats.meta.MetadataStore) */ 
    475449  public MetadataRetrieve asRetrieve(MetadataStore meta) { 
    476450    return meta instanceof MetadataRetrieve ? (MetadataRetrieve) meta : null; 
  • trunk/components/test-suite/src/loci/tests/ImageTester.java

    r6881 r7128  
    5353 
    5454/** 
    55  * A class for testing the {@link loci.formats.AWTImageTools#makeImage} methods. 
     55 * A class for testing the {@link loci.formats.gui.AWTImageTools#makeImage} 
     56 * methods. 
    5657 * 
    5758 * <dl><dt><b>Source code:</b></dt> 
Note: See TracChangeset for help on using the changeset viewer.