2

as titled. I know we can use @see or @link, but if there any standard method to avoid it. The example: two methods only differ on one parameter.

 /**
   * Enable Batching of single Point writes to speed up writes significant. If either actions or
   * flushDurations is reached first, a batchwrite is issued.
   * Note that batch processing needs to be explicitly stopped before the application is shutdown.
   * To do so call disableBatch().
   *
   * @param actions
   *            the number of actions to collect
   * @param flushDuration
   *            the time to wait at most.
   * @param flushDurationTimeUnit
   * @return the InfluxDB instance to be able to use it in a fluent manner.
   */
  public InfluxDB enableBatch(final int actions, final int flushDuration, final TimeUnit flushDurationTimeUnit);

  /**
   * Enable Batching of single Point writes to speed up writes significant. If either actions or
   * flushDurations is reached first, a batchwrite is issued.
   * Note that batch processing needs to be explicitly stopped before the application is shutdown.
   * To do so call disableBatch().
   *
   * @param actions
   *            the number of actions to collect
   * @param flushDuration
   *            the time to wait at most.
   * @param flushDurationTimeUnit
   * @param threadFactory
   * @return the InfluxDB instance to be able to use it in a fluent manner.
   */
  public InfluxDB enableBatch(final int actions, final int flushDuration, final TimeUnit flushDurationTimeUnit,
                              final ThreadFactory threadFactory);
jiafu
  • 6,338
  • 12
  • 49
  • 73
  • What exactly is your desired end result? Are you planning on using the javadoc tool to create HTML javadoc? – ajb Nov 07 '16 at 01:36
  • 2
    I wonder if these example should really have duplicated doc. The first method should explain how it creates threads, since it doesn't expect a `ThreadFactory` and the second one should explain how `ThreadFactory` is used. An empty `@param` list isn't helpful. – Tom Nov 07 '16 at 01:39

0 Answers0