ddoc: Params for all elements?

Stewart Gordon smjg_1998 at yahoo.com
Mon May 15 06:31:34 PDT 2006


Carlos Santander wrote:
> I'm not sure if this should be flagged as a bug, but I find it odd that 
> Params,
> Returns, and maybe others are accepted for modules, aliases, classes, and
> probably other elements. I mean, what does a module return? What are the
> parameters of an alias? I think ddoc shouldn't allow those sections, but 
> I'm not sure what the exact behavior should be.
<snip>

If it's a template declared using the

     class C(T)

notation, then it's the template parameter.  For an alias of a function 
pointer or delegate type, it's the parameters of the function to be 
expected.

Speaking of which, does any documentation system support a good way of 
documenting the parameters/returns of function pointers/delegates that 
are themselves parameter or return types?

Stewart.

-- 
-----BEGIN GEEK CODE BLOCK-----
Version: 3.1
GCS/M d- s:-@ C++@ a->--- UB@ P+ L E@ W++@ N+++ o K-@ w++@ O? M V? PS- 
PE- Y? PGP- t- 5? X? R b DI? D G e++++ h-- r-- !y
------END GEEK CODE BLOCK------

My e-mail is valid but not my primary mailbox.  Please keep replies on 
the 'group where everyone may benefit.



More information about the Digitalmars-d-bugs mailing list