Re: [Jsdoc-user] status of XMI/UML export?
Status: Inactive
Brought to you by:
mmathews
|
From: Cameron S. <sho...@op...> - 2005-03-21 09:57:15
|
Gabriel Reid wrote:
>>What else are you considering incorporating?
>>
>>
>
>Things I was thinking of adding were text documentation within the XMI,
>and additional relationships like composition and aggregation.
>
>If you or members of your development team have any more ideas or
>requests or whatever, please don't hesitate to contact me.
>
>Regards,
>
> Gabriel
>
>
Thanks Gabriel,
It is very nice of you to offer.
One more thing that would be useful would be to describe our directory
structure as packages within the XMI.
Ie,
We have directories for widget, model, and tool. It would be good if
jsdoc recognised a @package tag which I could put into the javascript. Eg:
/**
* Base Class for widgets.
* @constructor
* @package net.sourceforge.mapbuilder.widget
* @author Mike Adair
* @param widget Pointer to the widget instance being created
* @param widgetNode The widget's XML object node from the
configuration document.
* @param model The model object that this widget belongs to.
*/
function WidgetBase(widget,widgetNode,model) {
widget.model = model;
widget.widgetNode = widgetNode;
Alternatively, you could potentially extract the package name from the
directory structure. Although I think that might be harder to support
in jsdoc.
|