Skip to content

Constructor parameters appear in the docstring #135

@birkhola

Description

@birkhola

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions