Misleading Documentation

The class AtmosphereFramework.java contains the function initializationError

atmosphere/modules/cpr/src/main/java/org/atmosphere/cpr/AtmosphereFramework.java

Lines 3441 to 3448 in d350bc5

    
               /** 
        
                * If a {@link ContainerInitializer} fail, log the excetion here. 
        
                * 
        
                * @param initializationError 
        
                */ 
        
               public void initializationError(IllegalStateException initializationError) { 
        
                   this.initializationError = initializationError; 
        
               }

The current docstring is very misleading because the function is not doing any logging.

A better documentation would probably be:

* If a {@link ContainerInitializer} fails, set the field initializationError for later logging purposes.

or

* If a {@link ContainerInitializer} fails, set the field initializationError here.

Happy to improve it, would you like to submit a PR with your suggested change?

Yes, I will do that.

	/**
	* If a {@link ContainerInitializer} fail, log the excetion here.
	*
	* @param initializationError
	*/
	public void initializationError(IllegalStateException initializationError) {
	this.initializationError = initializationError;
	}