The ACE TLD documentation requires a general edit/review pass to improve overall quality and usefulness, and to ensure correctness.
---

Let's make sure that our documentation is truly useful. Some of it leaves a lot to be desired. I'll provide examples in ace:tooltip since I ran across it randomly.

@Property(tlddoc="Boolean value that makes tooltip global, which uses title attributes of elements in page to create the tooltip.", defaultValue="false")
private boolean global;

No idea what this means. Does global place the tooltip directly inside the body? Or it will somehow be used on every element in the page that has a title attribute?


@Property(tlddoc="The mouse event that the tooltip will be displayed (default mouseover)", defaultValue="mouseover")
private String showEvent;

@Property(tlddoc="The mouse event that the tooltip will be closed (default mouseout)", defaultValue="mouseout")
private String hideEvent;

What are all possible values?


@Property(tlddoc="The delay time of the tooltip display in milliseconds (default 140)", defaultValue="140")
private int showDelay;

@Property(tlddoc="The delay time of the tooltip hide in milliseconds (default 0)", defaultValue="0")
private int hideDelay;

@Property(tlddoc="Duration to display the show effect (default 500)", defaultValue="500")
private int showEffectLength;

@Property(tlddoc="Duration to display the hide effect (default 500)", defaultValue="500")
private int hideEffectLength;

The first two explain that the time is in milliseconds but the last two don't.


@Property(name="for", tlddoc="Specifies the id of the component that will display the tooltip")
private String forValue;

@Property(tlddoc="Specifies the id of the element that will display the tooltip")
private String forElement;

I'm not sure what the difference between these is. Is forElement an alternative to for, where I can display the tooltip on an element instead of a component? What is the precedence between the two?