Compex Documentation

Suggested improvements and new features.

Moderator: Moderators

Compex Documentation

Postby Kenneth Kassing » Mon Jun 18, 2001 11:44 am

Another possible addition to the functionality of MD would be to
implement links in documentation boxes which could reference other class
objects. The links should be functional in MD, similar to viewing an
objects owner, and also create an appropriate link when generating HTML
reports and such. However at the same time, not cluttering the
documentation in the source code.

For instance. When documenting an overloaded function in a derived class,
it would be appropriate to have access to the parent function. This should
be a natural quality, considering the object would share properties with its
parent.

Ken


Kenneth Kassing
 
Posts Rating:

Re: Compex Documentation

Postby Paule Zaksauskiene » Tue Jun 19, 2001 2:27 am

Ken,

thank you for suggestions, they will be discussed in the nearest future.

Regards,
--
Paule Zaksauskiene
Quality Assurance Engineer
UAB No Magic
Gedimino g. 47- 408, 3000 Kaunas, Lithuania
Phone: +370 7 324032 Fax: +370 7 320670
e-mail: paule.zaksauskiene
WWW: http://www.nomagic.com
--
OO software design can be an appealing challenge if you have
the best UML modeling tool: http://www.magicdraw.com


Kenneth Kassing wrote:

> Another possible addition to the functionality of MD would be to
> implement links in documentation boxes which could reference other class
> objects. The links should be functional in MD, similar to viewing an
> objects owner, and also create an appropriate link when generating HTML
> reports and such. However at the same time, not cluttering the
> documentation in the source code.
>
> For instance. When documenting an overloaded function in a derived class,
> it would be appropriate to have access to the parent function. This should
> be a natural quality, considering the object would share properties with its
> parent.
>
> Ken

Paule Zaksauskiene
 
Posts Rating:

Re: Compex Documentation

Postby dave » Fri Aug 10, 2001 6:38 am

Probably a little late in the thread but...

Couldn't you just make the documentation edit field work similar to the Text and Note elements?  This would also help get around a problem I'm having rendering the documentation in the reports.  If I specify preformatted, the lines don't wrap.  If I don't specify preformatted, I loose my linefeeds.  If I put br tags or p tags in my documentation, the documentation looks ugly in MD but would probably render fine in the reports.

Paule Zaksauskiene wrote: Ken,

thank you for suggestions, they will be discussed in the nearest future.

Regards,
--
Paule Zaksauskiene
Quality Assurance Engineer
UAB No Magic
Gedimino g. 47- 408, 3000 Kaunas, Lithuania
Phone: +370 7 324032 Fax: +370 7 320670
e-mail: paule.zaksauskiene
WWW: http://www.nomagic.com
--
OO software design can be an appealing challenge if you have
the best UML modeling tool: http://www.magicdraw.com

Kenneth Kassing wrote:

>     Another possible addition to the functionality of MD would be to
> implement links in documentation boxes which could reference other class
> objects.  The links should be functional in MD, similar to viewing an
> objects owner, and also create an appropriate link when generating HTML
> reports and such.  However at the same time, not cluttering the
> documentation in the source code.
>
> For instance.  When documenting an overloaded function in a derived class,
> it would be appropriate to have access to the parent function.  This should
> be a natural quality, considering the object would share properties with its
> parent.
>
>             Ken
dave
 
Posts Rating:


Return to Suggestions

Who is online

Users browsing this forum: No registered users and 2 guests

cron