Documentation

Suggested improvements and new features.

Moderator: Moderators

Documentation

Postby rsn » Sun Dec 31, 2000 1:41 pm

Hi all,

Can you add the option to choose the documentation type (pure text or html)
on every place / dialog where we can add documentation.
This allow developpers to add html documentation for javadoc generation.
But it also allow writing of use case specifications in pure text.
And any other combinaisons are allowed.
That be very useful for report generation, and for code generation too.

Happy New Year

Raphael Santerre



rsn
 
Posts Rating:

Re: Documentation

Postby Andrius Strazdauskas » Thu Jan 04, 2001 2:15 am

Raphael,

could you give more detail on this suggestion, it hard to determine what do
you mean.

Regards,
--
Andrius Strazdauskas
Project Leader
No Magic
Gedimino g. 47- 408, 3000 Kaunas, Lithuania
P.O. box 2166, LT- 3000, Kaunas, Lithuania
Phone: +370 7 324032 Fax: +370 7 320670
e-mail: andriuss
WWW: http://www.nomagic.com
--
OO software design can be appealing challenge if you have
the best UML modeling tool: http://www.magicdraw.com

"rsn" <rsanterre> wrote in message
news:92o251$ug0$1...
> Hi all,
>
> Can you add the option to choose the documentation type (pure text or
html)
> on every place / dialog where we can add documentation.
> This allow developpers to add html documentation for javadoc generation.
> But it also allow writing of use case specifications in pure text.
> And any other combinaisons are allowed.
> That be very useful for report generation, and for code generation too.
>
> Happy New Year
>
> Raphael Santerre
>
>
>


Andrius Strazdauskas
 
Posts Rating:

Re: Documentation

Postby rsn » Sun Jan 07, 2001 3:28 pm

When you document a model object in the specification dialogbox, you have to
enter the documentation either in pure text either in html. Because when you
generate the report (File | Report | Report options | Documentation as HTML
checkbox), you have to say that the object documentation is either in pure
text either in html.

I think you should let the MD user define the type of the documentation
(pure text or html) for every object's documentation.
So when i document a use case, i can do it in pure text because it is easier
or maybe because the one that do it doesn't know html.
But when i document a class, i will do it in html because i can use javadoc
later. And sometimes, i just want to do it in pure text because i just cut &
paste earlier specifications that are in pure text.

So, each time there is a documentation textarea in the specification
dialogbox for a model object, the user should also have the choice of the
type of documentation (pure text or html). And because it can be boring to
have to define the type of documentation each time, it should be pre-set in
the Project Options (Options | Project ... | Style | Default). The global
documentation type could be overwritten on each model object type (Class,
Node Instance, Subactivity State, ...). And the default documentation type
for an model object type define the defaut state when the object's
specification dialog box is open (as long as the user doesn't overwrite the
default documentation type for that specific model object).

On the Report side, the report engine has to look for the documentation type
(pure text or html) of each object that will be documented in the report.

I hope this will help you.
Sincerely

Raphael Santerre



rsn
 
Posts Rating:

Re: Documentation

Postby Andrius Strazdauskas » Tue Jan 09, 2001 8:53 am

Raphael,

Thanks for the suggestion.
However 4.0 version has a brand new version of reports. We'll consider your
suggestion.

Regards,
--
Andrius Strazdauskas
Project Leader
No Magic
Gedimino g. 47- 408, 3000 Kaunas, Lithuania
P.O. box 2166, LT- 3000, Kaunas, Lithuania
Phone: +370 7 324032 Fax: +370 7 320670
e-mail: andriuss
WWW: http://www.nomagic.com
--
OO software design can be appealing challenge if you have
the best UML modeling tool: http://www.magicdraw.com



Andrius Strazdauskas
 
Posts Rating:


Return to Suggestions

Who is online

Users browsing this forum: No registered users and 0 guests