[Laszlo-dev] Doc question

[Jim Grandy]

Hi Tucker,

We currently don't have a perfect story for this situation. What  
we're doing is what you see with e.g. LzTimer and LzTrack.  
Essentially we document these singletons through their parent class  
(LzTimerClass and LzTrackClass) rather than documenting the singleton  
itself. This is something I'd like to improve, but if you follow that  
pattern then we can improve your code along with the others when we  
get there.

jim

On Jul 5, 2007, at 5:00 AM, P T Withington wrote:

> I am writing a class LzFormatter that will have a singleton  
> instance LzFormat to make formatToString available in the LFC  
> without the debugger.  What's the proper way to document this?  I  
> have documentation on the formatToString method in the class, but  
> the user API is LzFormat.formatToString.
>
> [Alternatively, I could make LzFormatter a mixin, and mix it into  
> both the debugger and LzText, but right now the debugger is not  
> written as a class, so this is the path of least resistance.]