genjavadoc icon indicating copy to clipboard operation
genjavadoc copied to clipboard

Constructor parameters appear in the docstring

Open birkhola opened this issue 7 years ago • 0 comments

e.g.

/** Constructs a Driver by creating and adding one or more testing tasks.
  *
  * @param completeConfig The complete configuration
  * @param context The driver context with data available to all driver tasks
  * @param rootLogContext the root log context for the Driver
  */
class DriverBuilder(completeConfig: CompleteConfig, context: DriverContext, rootLogContext: LogContext)
    extends my.core.java.common.builder.DriverBuilder(
        completeConfig,
        context,
        rootLogContext) { ... }

results in

public class DriverBuilder
extends DriverBuilder
 
Constructs a Driver by creating and adding one or more testing tasks.
 
param: completeConfig The complete configuration param: context The driver context with data available to all driver tasks param: rootLogContext the root log context for the Driver

birkhola avatar Apr 25 '18 10:04 birkhola