CODEWITHSUNDEEP
jenkinsjenkins-pipelinejavadoc
user797963
user797963

Reputation: 3027

Jenkins Pipeline - how to javadoc a global pipeline library?

Is there a way to run javadoc or the groovy equivalent against a global pipeline library? I out of habit wrote comments for every method that follow the javadoc format - would love if I could run javadoc against the library and have doc generated.

Upvotes: 1

Views: 1066

Answers (1)

StephenKing
StephenKing

Reputation: 37620

As described in the documentation, global variables (inside vars/) are documented in a <name>.txt file next to the <name>.groovy file.

Groovy classes within src/ are.. well.. just Groovy code and thus GroovyDoc should be used.

Upvotes: 2

Related Questions