Hi,

We make use of the Global Shared Libraries in Jenkins Pipeline.

We have some global variables defined in the vars/ directory.

For example:

#!groovy
// vars/dummy.groovy

/**
 * Welcomes you!
 *
 * @param steps
 *     The steps from the declarative pipeline.
 */
def call(steps) {
    steps.echo "Hello there!"
}

When we go to the pipeline-syntax/globals URL of the job (i.e. <JOB_URL>/pipeline-syntax/globals), then we see the global variable listed, but we don't see its (javadoc) documentation.

This makes it hard for users of our Global Shared Libraries to know what the global variable / function really does and what info is available in this variable/function.

• Is there any way to include the documentation on this page?
• Does the documentation support javadoc, markdown, restructured text, ...?

If not, it would be great to see this implemented!

Thank you in advance!

With best regards,
Tom.