tracker issue : CF-3711305

Note, this is not a regression-- it's just always been parsed wrong.  It would be great to see the fix roll out in CF11 though.

I'm comparing the CFML behavior to Java since that's where we copied JavaDocs from.

Consider the following method:

/**
* Shutdown the native client connection
* 
* @timeout.hint The timeout in seconds, we default to 10 seconds
* 				so that we can do stuff
* 
* @return A reference to "this" CFC
*			so that it can work.
*/
CouchbaseClient function shutdown( numeric timeout=10 ){
	// implementation
	return this;
}

The parameter hint and @return annotation both have a line break. In Java, all text up until the next "@" would be part of the string. Instead, ColdFusion strips off the additional lines lines concatenates them to the method hint.

Here is what the javadoc documentation says about method comments (hint in CFML):

"The first line that begins with an "@" character ends the description. There is only one description block per doc comment; you cannot continue the description following block tags."

Also, here are example of valid JavaDocs that demonstrate line breaks used for parameter hints and @return annotations:

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#examples

----------------------------- Additional Watson Details -----------------------------

Watson Bug ID:	3711305

External Customer Info:
External Company:  
External Customer Name: bradwood.com
External Customer Email:  
External Test Config: My Hardware and Environment details:

Attachments:

Comments: