[Issue 7688] New: Ddoc should give a list of inherited members

[d-bugmail at puremagic.com]

http://d.puremagic.com/issues/show_bug.cgi?id=7688

           Summary: Ddoc should give a list of inherited members
           Product: D
           Version: D1 & D2
          Platform: All
        OS/Version: All
            Status: NEW
          Keywords: ddoc
          Severity: enhancement
          Priority: P2
         Component: DMD
        AssignedTo: nobody at puremagic.com
        ReportedBy: smjg at iname.com


--- Comment #0 from Stewart Gordon <smjg at iname.com> 2012-03-11 11:19:44 PDT ---
Currently, Ddoc lists only the members of a class that actually have
documentation comments in that very class.  Inherited members are not listed at
all, and so the reader is forced to walk up the class hierarchy to see what
inherited members exist.  This is undesirable.

There are a few possible cases to consider:

(a) The member is just inherited - not overridden
(b) the member is overridden, but the override has no documentation comment
(c) the member is overridden, with documentation specific to this class's
version of it

Currently, in case (a), the member is just listed with the new documentation. 
But in (b) and (c), the member is just not listed.

As there can be a lot of inherited members, it would be undesirable to clutter
up the documentation by listing them all in detail.  But one possibility is to
have (c) as a list similar to that produced by Javadoc.

For cases of (b), we could list them along with (c), or the way we already list
members of the class, copying the documentation from the superclass.

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