[doc] Things I'd like to see documented

[jfarcand]

See

   http://groups.google.com/group/atmosphere-framework/msg/0856e98d2bbbd816

[chris-martin]

Why would I want or need to set a particular atmosphere property to 'true' or 'false'"?

This remark perfectly summarizes my frustration with the documentation. AtmosphereResource, in particular, has some fundamental concepts that could use some explanation. The following kind of thing is very unhelpful:

     * @return <tt>true<//tt> if that {@link AtmosphereResource#resume()} has been
     *         invoked and set to <tt>true</tt>
     */
    public boolean isResuming();

The biggest problem is that it leaves unanswered: Under what circumstance does the Atmosphere framework invoke #resume()? I still don't fully understand what it means for a resource to "be resuming". Same goes for the rest of the state boolean on Atmosphere resource (suspended, resumedOnTimeout, cancelled). I'm sure these properties are probably related to each other in some way. For example, can a resource be both suspended and cancelled at the same time? I would think not, but I'm not sure.

[jfarcand]

@chris-martin I fully agree. Feel free to file more issue with such non sense comments I wrote. For sure I will work on that. Thanks!

[jfarcand]

Added a table for Atmosphere Configuration attributes

https://github.com/Atmosphere/atmosphere/wiki/Configuring-Atmosphere-using-the-web.xml-or-atmosphere.xml

[jfarcand]

Mark this bug as fixed. Please file new one with specific requests if you think the current wiki lack.