mulesoft/mule-devkit — Issue #77: [BUG] - Attributes documentation text truncated
Author: flbulgarelli
Created: 2012-01-17 14:58:05+00:00
State: open

When html moodule documentation is generated for attributes, only first sentence of its javadoc is used. For example, in http://mulesoft.github.com/coupa-connector/mule/coupa.html#config, the following documentation line was generated for attribute baseUrl:

The base URL of your company's account in Coupa.

However, this is not the full javadoc for that attribute. Check https://github.com/mulesoft/coupa-connector/blob/master/src/main/java/org/mule/modules/coupa/CoupaModule.java:

```java
/**
* The base URL of your company's account in Coupa. Its looks like
* https://[company].[coupahost].com/api
*/
@Configurable
private String baseUrl;
```

Javadoc tool normally handles first sentence of javadoc text specially. The devkit should, however, display somewhere the full text, either by showing it completely, or by linking to the full javadoc, for instance, the API Referene http://mulesoft.github.com/coupa-connector/java/org/mule/modules/coupa/CoupaModule.html

Otherwise, non experimented users will never be aware of the existence of the full documentation.