Jenkins Javadocs are not available

[Paul Sokolovsky]

Hello,

https://wiki.jenkins-ci.org/display/JENKINS/Extension+points wiki page
lists quite a bunch of extension points, linking to javadocs for each,
with url of form

http://javadoc.jenkins-ci.org/byShortName/<package-name>

e.g.http://javadoc.jenkins-ci.org/byShortName/com.cloudbees.plugins.credentials.CredentialsProvider

Unfortunately all the links appear to lead to nowhere, and actually
parent dir appears to be empty:

http://javadoc.jenkins-ci.org/byShortName/


Hopefully, something can be done about that.


Thanks,
Paul

Linaro.org | Open source software for ARM SoCs
Follow Linaro: http://www.facebook.com/pages/Linaro
http://twitter.com/#!/linaroorg - http://www.linaro.org/linaro-blog

[Christopher Orr]

Hi there,

As per INFRA-180 [0], that wiki page isn't currently being updated
automatically, and only shows third-party extension points, and nothing
from core. That's why the Javadoc links go nowhere — they belong to
plugins.

The Jenkins core Javadoc itself (and short links) does work:
http://javadoc.jenkins-ci.org/
http://javadoc.jenkins-ci.org/byShortName/Util

There is (somewhere) a super repository that contains the code for core
and all plugins together (to make searching for examples easy), but I
can't find the info for that.

Often I just do GitHub searches on the "jenkinsci" organisation:
https://github.com/search?type=Code&q=user%3Ajenkinsci+credentialprovider

Regards,
Chris

[0]:https://issues.jenkins-ci.org/browse/INFRA-180

[Paul Sokolovsky]

Hello,

On Fri, 10 Apr 2015 20:22:51 +0200
Christopher Orr <ch...@orr.me.uk> wrote:

> Hi there,
>
> As per INFRA-180 [0], that wiki page isn't currently being updated
> automatically, and only shows third-party extension points, and
> nothing from core. That's why the Javadoc links go nowhere — they
> belong to plugins.
>
> The Jenkins core Javadoc itself (and short links) does work:
> http://javadoc.jenkins-ci.org/
> http://javadoc.jenkins-ci.org/byShortName/Util
>
> There is (somewhere) a super repository that contains the code for
> core and all plugins together (to make searching for examples easy),
> but I can't find the info for that.
>
> Often I just do GitHub searches on the "jenkinsci" organisation:
> https://github.com/search?type=Code&q=user%3Ajenkinsci+credentialprovider

Thanks for the response. Looking directly into source is what I reduced
to already. But of course it's not as comfortable as browsing javadoc,
so I hope there's some plan in TODO on how to get javadocs for core,
widely depended-on plugins online.

>
> Regards,
> Chris
>


--
Best Regards,

[Christopher Orr]

On 10/04/15 20:30, Paul Sokolovsky wrote:
> On Fri, 10 Apr 2015 20:22:51 +0200 Christopher Orr <ch...@orr.me.uk> wrote:
>> As per INFRA-180 [0], that wiki page isn't currently being updated
>> automatically, and only shows third-party extension points, and
>> nothing from core. That's why the Javadoc links go nowhere — they
>> belong to plugins.
>>
>> The Jenkins core Javadoc itself (and short links) does work:
>> http://javadoc.jenkins-ci.org/
>> http://javadoc.jenkins-ci.org/byShortName/Util
>>
>> There is (somewhere) a super repository that contains the code for
>> core and all plugins together (to make searching for examples easy),
>> but I can't find the info for that.
>>
>> Often I just do GitHub searches on the "jenkinsci" organisation:
>> https://github.com/search?type=Code&q=user%3Ajenkinsci+credentialprovider
>
> Thanks for the response. Looking directly into source is what I reduced
> to already. But of course it's not as comfortable as browsing javadoc,
> so I hope there's some plan in TODO on how to get javadocs for core,
> widely depended-on plugins online.

AFAIK, there has been no discussion about generating and publishing the
Javadoc for anything other than core. I guess people get by with
reading the code of other plugins (or asking on the mailing list/IRC).

But it wouldn't be an unreasonable feature request to file, though I'm
not sure that many plugins have extensive and up-to-date Javadoc coverage.

Regards,
Chris

[Daniel Beck]

On 10.04.2015, at 20:22, Christopher Orr <ch...@orr.me.uk> wrote:

> There is (somewhere) a super repository that contains the code for core and all plugins together (to make searching for examples easy), but I can't find the info for that.

https://wiki.jenkins-ci.org/display/JENKINS/Grepping+all+sources