www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - DDoc's params section

reply Victor Nakoryakov <Victor_member pathlink.com> writes:
Hi all.

After long pause I resumed development in D and first thing I've done is
documentation of some part of code to investigate how ddoc works. Great, but
there is one lack of feature I discovered and was astonished. Consider:
/**
Returns: Whether passed basis is orthonormal.
Params:
r, s, t =   Vectors that form a basis.
relprec, absprec = Parameters passed to equal function while calculations.
Have the same meaning as in equal function.
References:
$(LINK http://en.wikipedia.org/wiki/Orthonormal_basis)
*/

I have empty params section after generation. Well, this is because parameters
are not described separately but enumerated in comma list. Is there any reasons
why ddoc can't correctly process this?

--
Victor (aka nail) Nakoryakov
nail-mail<at>mail<dot>ru

Krasnoznamensk, Moscow, Russia
Jan 20 2006
parent Chris Lajoie <ctlajoie___remove___this___ ___gmail.com> writes:
Victor Nakoryakov wrote:
 Hi all.
 
 After long pause I resumed development in D and first thing I've done is
 documentation of some part of code to investigate how ddoc works. Great, but
 there is one lack of feature I discovered and was astonished. Consider:
 /**
 Returns: Whether passed basis is orthonormal.
 Params:
 r, s, t =   Vectors that form a basis.
 relprec, absprec = Parameters passed to equal function while calculations.
 Have the same meaning as in equal function.
 References:
 $(LINK http://en.wikipedia.org/wiki/Orthonormal_basis)
 */
 
 I have empty params section after generation. Well, this is because parameters
 are not described separately but enumerated in comma list. Is there any reasons
 why ddoc can't correctly process this?

It probably just wasn't considered. Hopefully Walter will see this, but I think he reads more of the posts in digitalmars.D.bugs than he does in this NG. Chris
Jan 20 2006