Changeset 6132


Ignore:
Timestamp:
Sep 14, 2012, 12:29:16 PM (9 years ago)
Author:
Nicklas Nordborg
Message:

Fixes #1726: Fix javadoc warnings

Location:
trunk
Files:
2 deleted
17 edited

Legend:

Unmodified
Added
Removed
  • trunk/build.xml

    r6130 r6132  
    12021202    </tstamp>
    12031203    <delete dir="${doc}/api" />
     1204    <sleep milliseconds="1000"/>
    12041205    <mkdir dir="${doc}/api" />
    12051206
     
    12641265      <link href="http://www.singularsys.com/jep/doc/javadoc/" />
    12651266      <link href="http://www.jfree.org/jfreechart/api/gjdoc/" />
    1266       <link href="http://logging.apache.org/log4j/docs/api/" />
     1267      <link href="http://logging.apache.org/log4j/1.2/apidocs/" />
    12671268      <link href="http://download.oracle.com/docs/cd/E17802_01/products/products/java-media/jai/forDevelopers/jai-apidocs/" />
    12681269      <tag name="base.developer" description="Developer info" />
  • trunk/src/clients/web/net/sf/basedb/clients/web/Base.java

    r5946 r6132  
    446446    @since 2.7
    447447  */
    448   @SuppressWarnings("unchecked")
    449448  public static ItemContext getAndSetCurrentContext(SessionControl sc, Item itemType,
    450449    String subContext, ServletRequest request, ItemContext defaultContext, boolean resetTemporary)
     
    14651464    @since 3.0
    14661465  */
    1467   @SuppressWarnings("unchecked")
    14681466  public static void updateFiles(DbControl dc, FileStoreEnabled item,
    14691467    HttpServletRequest request, boolean validate,
  • trunk/src/clients/web/net/sf/basedb/clients/web/plugins/BioMaterialEventSourceFormatter.java

    r5963 r6132  
    2525import net.sf.basedb.core.BioMaterial;
    2626import net.sf.basedb.core.BioMaterialEventSource;
    27 import net.sf.basedb.core.Nameable;
    2827import net.sf.basedb.core.PermissionDeniedException;
    2928import net.sf.basedb.util.formatter.Formatter;
     
    5150    Create a new formatter.
    5251    @param nullValue The string to return if a null item is
    53       passed to {@link #format(Nameable)}
     52      passed to {@link #format(BioMaterialEventSource)}
    5453  */
    5554  public BioMaterialEventSourceFormatter(String nullValue)
  • trunk/src/clients/web/net/sf/basedb/clients/web/plugins/DataQueryWrapper.java

    r6127 r6132  
    4343  /**
    4444    Create a new query wrapper.
    45     @param dc The DbControl used to execute the query
    4645    @param query The query
    4746    @since 2.15
  • trunk/src/clients/web/net/sf/basedb/clients/web/plugins/DynamicQueryWrapper.java

    r6127 r6132  
    4646  /**
    4747    Create a new query wrapper.
    48     @param dc The DbControl used to execute the query
    4948    @param query The query
    5049  */
  • trunk/src/clients/web/net/sf/basedb/clients/web/plugins/ItemQueryWrapper.java

    r6127 r6132  
    4242  /**
    4343    Create a new query wrapper.
    44     @param dc The DbControl used to execute the query
    4544    @param query The query
    4645    @since 2.15
  • trunk/src/clients/web/net/sf/basedb/clients/web/plugins/ReporterScoreQueryWrapper.java

    r6127 r6132  
    4343  /**
    4444    Create a new query wrapper.
    45     @param dc The DbControl used to execute the query
    4645    @param query The query
    4746  */
  • trunk/src/core/net/sf/basedb/core/BioPlateType.java

    r6127 r6132  
    300300    Set the subtype of storage location where plates of this type are usually stored.
    301301    The storage type should be a subtype for hardware items.
    302     @param subtype A subtype or null if the subtype is not important
     302    @param storageType A subtype or null if the subtype is not important
    303303    @since 3.2
    304304  */
  • trunk/src/core/net/sf/basedb/core/PhysicalBioAssay.java

    r6127 r6132  
    289289
    290290  /**
    291     Get the extracts, possible on a specific assay position or only a specific
    292     extract, and the array slide.
     291    Get the extracts, possible on a specific assay position or only a given set of specific
     292    extracts, and the array slide.
    293293    @param position If > 0 only include the extracts on that
    294294      position in the bioassay (see {@link BioMaterialEventSource#getPosition()}.
    295295      If <= 0 include all extracts.
    296     @param extract If not null, only include that extract (if present on the
     296    @param extracts If not null or empty, only include the given extracts (if present on the
    297297      bioassay)
    298298    @since 3.2
  • trunk/src/core/net/sf/basedb/core/Reporter.java

    r5885 r6132  
    168168   
    169169    Use this method only when you need to get a few reporters. If you need
    170     to get many reporter use the {@link ReporterCloneBatcher#getByExternalId(String)}
     170    to get many reporters use a query from the {@link #getDynamicQuery(Experiment)}
    171171    method instead. It has better performance since it resuses a single
    172172    query instead of creating a new one each time as this method does.
  • trunk/src/core/net/sf/basedb/core/Update.java

    r6124 r6132  
    4848import net.sf.basedb.core.data.BioMaterialEventSourceData;
    4949import net.sf.basedb.core.data.BioPlateData;
     50import net.sf.basedb.core.data.BioPlateTypeData;
    5051import net.sf.basedb.core.data.ContextData;
    5152import net.sf.basedb.core.data.DataFileTypeData;
  • trunk/src/core/net/sf/basedb/core/data/PhysicalBioAssayData.java

    r6082 r6132  
    109109  /**
    110110    This is the inverse end with an extra restriction
    111     @see DerivedBioAssayData#getPhysicalBioAssay()
     111    @see DerivedBioAssayData#getPhysicalBioAssays()
    112112    @hibernate.set table="`ParentPhysicalBioAssays`" lazy="true" inverse="true"
    113113    @hibernate.collection-key column="`physicalbioassay_id`"
  • trunk/src/core/net/sf/basedb/core/log/db/DefaultEntityLogger.java

    r6080 r6132  
    5858  /**
    5959    Creates a new {@link ChangeHistoryDetailData} and saves it to
    60     {@link DbLogManager#logChangeDetails(ChangeHistoryDetailData)}.
     60    {@link DbLogManager#logChangeDetails(ChangeHistoryDetailData, EntityDetails)}.
    6161  */
    6262  @Override
  • trunk/src/core/net/sf/basedb/core/query/Annotations.java

    r6022 r6132  
    293293    @return A join query element
    294294    @throws InvalidDataException If the annotationType or joinedAlias is null
    295     @since 3.2
    296   */
    297   public static Join leftJoin(AnnotationType annotationType)
    298   {
    299     return leftJoin(null, annotationType, null);
     295    @since 3.3
     296  */
     297  public static Join leftJoin(AnnotationType annotationType, String joinedAlias)
     298  {
     299    return leftJoin(null, annotationType, joinedAlias);
    300300  }
    301301 
     
    314314  {
    315315    if (annotationType == null) throw new InvalidUseOfNullException("annotationType");
     316    if (joinedAlias == null) throw new InvalidUseOfNullException("joinedAlias");
    316317    return new AnnotationJoin(JoinType.LEFT, alias, annotationType, joinedAlias);
    317318  }
  • trunk/src/core/net/sf/basedb/util/TransferRateProgressReporter.java

    r6070 r6132  
    2424   
    2525    @param parent An optional parent progress reporter
    26     @param ticksPerSecond Max allowed ticks-per-second, if the rate goes above this,
     26    @param maxTicksPerSecond Max allowed ticks-per-second, if the rate goes above this,
    2727      the {@link #displayAbsolute(long, String)} method will wait a short time
    2828      before returning
     
    3838   
    3939    @param parent An optional parent progress reporter
    40     @param ticksPerSecond Max allowed ticks-per-second, if the rate goes above this,
     40    @param maxTicksPerSecond Max allowed ticks-per-second, if the rate goes above this,
    4141      the {@link #displayAbsolute(long, String)} method will wait a short time
    4242      before returning
  • trunk/src/core/net/sf/basedb/util/overview/OverviewUtil.java

    r6091 r6132  
    7474  /**
    7575    @return Same as {@link #getStaticRules()}
    76     @deprecated In 3.2, use {@link #getStaticRules()} or {@link #getAllRules(DbControl, BasicItem)} instead
     76    @deprecated In 3.2, use {@link #getStaticRules()} or {@link #getAllRules(DbControl, GenericOverview)} instead
    7777  */
    7878  @Deprecated
     
    189189    is a title that groups related validation rules, for example:
    190190    "Project default", "Missing items", etc.
    191     @param An open DbControl
    192     @param The root item of the overview tree
     191    @param dc An open DbControl
     192    @param overview The overview tree
    193193    @return A map with a string key and list of validation rules
    194194      as value
  • trunk/src/core/net/sf/basedb/util/overview/loader/BioPlateLoader.java

    r6044 r6132  
    9494  /**
    9595    Load the freezer node.
    96     @see HardwareLoader#createPropertyNode(DbControl, OverviewContext, Node)}
     96    @see HardwareLoader#createPropertyNode(DbControl, OverviewContext, Node)
    9797  */
    9898  @Override
Note: See TracChangeset for help on using the changeset viewer.