Show getServices() in javadocs

[sammefford]

While the protected method getServices() is mentioned in the class-level javadoc, the method should ideally be visible in the table of methods. It is a key method for using and extending the ResourceManager. I'm not sure if we have any limitation here as we generate our javadoc with maven, but I'll look into it.

[grechaw]

Maven just calls javadoc. I don't think it has anything to do with the missing method. Maybe it's an override?

[sammefford]

First I need to add javadoc on this method. Then we just need to configure our javadoc call in maven to build javadoc including that protected method.

[ehennum]

Hi, Sam and Charles:

We made a deliberate decision to limit the JavaDoc to public methods.

If we undo that decision and switch to showing protected methods,that's
will add a lot of noise to the JavaDoc -- methods that people don't or
shouldn't care about.

If the only concern is the single method, could we consider alternatives?

[sammefford]

The only concern at the moment is the single method. It seems to be an important method. It confused me when I saw how it was used in the examples, then I couldn't find it where I expected it in the javadocs.

Yes, we should consider alternatives so we don't show methods we don't want in the javadocs.

I wasn't planning to address this right now, but since I noticed it I wanted to get it in the issues list for us to come back to later.

[grechaw]

I see, so javadocs would be very useful to us as internal developers, but this isn't something an application developer should ever have to use.

[sammefford]

No, I was thinking this should be there for external developers. If they need to use the method, I want it to be easy to find. Maybe I'm naive to think I can configure a build which creates the javadoc for one protected method and not for all others.