ddoc: Params for all elements?

Carlos Santander csantander619 at gmail.com
Tue May 23 10:45:32 PDT 2006


Walter Bright escribió:
> 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.
>>
>> And as a related note, whatever is done with the previous issue, 
>> should also be done when trying to document parameters that don't exist:
>>
>> /// Params:
>> /// a = nothing
>> void foo() {}
> 
> Sometimes there are parameters to functions that aren't in the 
> function's parameter list, such as a global variable.
> 
> One of the design goals for Ddoc is that it doesn't produce error 
> messages - it attempts to produce reasonable output regardless.

I guess that kinda makes sense, even if I don't understand what a class might 
return... he he... I don't know, I supposed some things could be marked as 
invalid in some places, but that goes against Ddoc design. Oh well, it's good to 
  know, anyway.

-- 
Carlos Santander Bernal



More information about the Digitalmars-d-bugs mailing list