Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Constructor parameters appear in the docstring #135

Open
birkhola opened this issue Apr 25, 2018 · 0 comments
Open

Constructor parameters appear in the docstring #135

birkhola opened this issue Apr 25, 2018 · 0 comments

Comments

@birkhola
Copy link

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant