Bizarre documentation issues

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Bizarre documentation issues

ipsi
This is really, really crazy:

I'm using gpars-0.11, and I wanted to know how the shutdown() method of PGroup worked, so I figured I'd have a look at the docs on the project site, since the docs and source aren't in Maven (which is really annoying).

So I go to gpars.org, which points me to Codehaus. I go to Codehaus, and have a look at the Groovydocs http://gpars.org/groovydoc/index.html . Finding the PGroup class is pretty easy, but the shutdown() method doesn't exist in the documentation. Wait, what? Man, that's a bit odd. Especially since it's mentioned in the class description of DefaultPGroup!

Maybe it's in the Javadocs. I have a look at http://gpars.org/javadoc/index.html, and I can't find the PGroup class at all! That's *really* weird.

So I figure I'll have to look at the source. Annoying, but at least I'm guaranteed to find it. Except that I'm not. As far as I can tell, there is no such class as PGroup in GPars. So, either I'm looking the the wrong place for the docs (unlikely), the class has been removed recently (possible), or the build is completely wack (also possible).

Can someone explain to me what the hell is going on? Have I gone completely mad?
Reply | Threaded
Open this post in threaded view
|

Re: Bizarre documentation issues

Vaclav
Administrator
Don't wory, you are perfectly sane. What you're experiencing is a direct consequence of PGroup being defined in the ActorGroup.groovy file, due to an incomplete rename in the past. This will be fixed in 0.12.

Groovy doc is more likely to give you the right info - http://gpars.org/groovydoc/groovyx/gpars/group/PGroup.html, however, just as you say, the shutdown() method is not listed in the PGroup class.
PGroup uses @Delegate to inject methods of Pool, including the shutdown() method, but groovydoc doesn't seem to be aware of @Delegate and that's why it looks like there's no shutdown() method available on PGroup. So, finally, Pool.shutdown() is the method you are looking for.

Cheers,

Vaclav


I'm using gpars-0.11, and I wanted to know how the shutdown() method of
PGroup worked, so I figured I'd have a look at the docs on the project site,
since the docs and source aren't in Maven (which is really annoying).

So I go to gpars.org, which points me to Codehaus. I go to Codehaus, and
have a look at the Groovydocs http://gpars.org/groovydoc/index.html .
Finding the PGroup class is pretty easy, but the shutdown() method doesn't
exist in the documentation. Wait, what? Man, that's a bit odd. Especially
since it's mentioned in the class description of DefaultPGroup!

Maybe it's in the Javadocs. I have a look at
http://gpars.org/javadoc/index.html, and I can't find the PGroup class at
all! That's *really* weird.

So I figure I'll have to look at the source. Annoying, but at least I'm
guaranteed to find it. Except that I'm not. As far as I can tell, there is
no such class as PGroup in GPars. So, either I'm looking the the wrong place
for the docs (unlikely), the class has been removed recently (possible), or
the build is completely wack (also possible).

Can someone explain to me what the hell is going on? Have I gone completely
mad?

--
View this message in context: http://gpars-user-mailing-list.19372.n3.nabble.com/Bizarre-documentation-issues-tp2978893p2978893.html
Sent from the GPars - user mailing list mailing list archive at Nabble.com.

---------------------------------------------------------------------
To unsubscribe from this list, please visit:

   http://xircles.codehaus.org/manage_email





--
E-mail: [hidden email]
Blog: http://www.jroller.com/vaclav
Linkedin page: http://www.linkedin.com/in/vaclavpech