www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.bugs - [Issue 7688] New: Ddoc should give a list of inherited members

reply d-bugmail puremagic.com writes:
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 puremagic.com
        ReportedBy: smjg iname.com


--- Comment #0 from Stewart Gordon <smjg 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: -------
Mar 11 2012
next sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=7688



--- Comment #1 from Stewart Gordon <smjg iname.com> 2012-10-27 07:50:44 PDT ---
(In reply to comment #0)

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


Hang on, this doesn't make sense.  Guess I must've reordered them at some point
and inadvertently left the commentary how it was.  Should say:

Currently, in case (c), the member is just listed with the new documentation. 
But in (a) and (b), the member is just not listed.  Likewise, subsequent
references to (c) should be referring to (a).

-- 
Configure issuemail: http://d.puremagic.com/issues/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
Oct 27 2012
prev sibling parent d-bugmail puremagic.com writes:
http://d.puremagic.com/issues/show_bug.cgi?id=7688


Andrej Mitrovic <andrej.mitrovich gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |andrej.mitrovich gmail.com


--- Comment #2 from Andrej Mitrovic <andrej.mitrovich gmail.com> 2012-11-02
01:28:10 PDT ---
I almost like Qt's documentation engine. For example:
http://qt-project.org/doc/qt-4.8/qmenubar.html

It lists overriden methods in 'Reimplemented' sections, and has a link to the
inherited class. The latter could be incorporated via Issue 198 (man that's an
ancient request).

But I would prefer if we could list inherited (non-overriden) methods in some
kind of html tree control that is minimized by default but can be expanded
rather than having to click to open the base-class page.

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