www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 11511] New: DDoc - the parameter list of a variadic function cannot be documented properly

https://d.puremagic.com/issues/show_bug.cgi?id=11511

           Summary: DDoc - the parameter list of a variadic function
                    cannot be documented properly
           Product: D
           Version: D2
          Platform: All
        OS/Version: All
            Status: NEW
          Keywords: ddoc
          Severity: minor
          Priority: P2
         Component: DMD
        AssignedTo: nobody puremagic.com
        ReportedBy: rumbu rumbu.ro


--- Comment #0 from Răzvan Ștefănescu <rumbu rumbu.ro> 2013-11-13 08:33:17
PST ---
Assuming the following function:

void foo(int i, ...)

Documentation of the variable parameter list is not formatted correctly:

Example

///Parameters: i   =  some integer parameter
///            ... =  variable length list of arguments

The DDoc output will not automatically align and break the line after "i"
documentation

Documenting "..." as something else (e.g. "args") will output a compiler
warning.

Proposal: interpret "..." as parameter or accept "args" as replacement without
warning.

-- 
Configure issuemail: https://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Nov 13 2013