More compact documentation generation

Suggested improvements and new features.

Moderator: Moderators

More compact documentation generation

Postby Srinivas Nedunuri » Wed Mar 21, 2001 6:14 pm

1. Hello, may I suggest a more compact documentation generation format. The
current form, with multiple html files and rather verbose tables is very
space consuming. For example, the information about a method could be
displayed in a single line
public static void foo(...)
/* documentation about foo */
rather than the current table format:
name foo
public yes
static yes

etc.

As an example, you might want to take a look at the documentation format
generated by UML Studio, or ObjectDomain, etc.

2. Also, do you have any plans to generate say pdf or latex documents?


Srinivas Nedunuri
 
Posts Rating:

Re: More compact documentation generation

Postby Martynas Lelevicius » Thu Mar 22, 2001 8:39 am

Hi Srinivas,
Thank you for your suggestions. Here go the answers:

> 1. Hello, may I suggest a more compact documentation generation format.
The
> current form, with multiple html files and rather verbose tables is very
> space consuming.

MagicDraw generates reports with all possible information that can be
retrieved from the project. It is difficult to show all that information in
one line and programming language dependent way. But we consider feature to
generate "lite" version of reports with minimal but essential data.

> 2. Also, do you have any plans to generate say pdf or latex documents?

Not in the nearest future. However this functionality is in our future
feature list.


Regards,
--
Martynas Lelevicius
Programmer
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: marte
WWW: http://www.nomagic.com


"Srinivas Nedunuri" <s_nedunuri> wrote in message
news:99bgb6$vco$1...
> 1. Hello, may I suggest a more compact documentation generation format.
The
> current form, with multiple html files and rather verbose tables is very
> space consuming. For example, the information about a method could be
> displayed in a single line
> public static void foo(...)
> /* documentation about foo */
> rather than the current table format:
> name foo
> public yes
> static yes
>
> etc.
>
> As an example, you might want to take a look at the documentation format
> generated by UML Studio, or ObjectDomain, etc.
>
> 2. Also, do you have any plans to generate say pdf or latex documents?
>
>


Martynas Lelevicius
 
Posts Rating:


Return to Suggestions

Who is online

Users browsing this forum: No registered users and 1 guest