D issues are now tracked on GitHub. This Bugzilla instance remains as a read-only archive.
Issue 7688 - Ddoc should give a list of inherited members
Summary: Ddoc should give a list of inherited members
Status: NEW
Alias: None
Product: D
Classification: Unclassified
Component: dmd (show other issues)
Version: D2
Hardware: All All
: P4 enhancement
Assignee: No Owner
URL:
Keywords: ddoc
Depends on:
Blocks:
 
Reported: 2012-03-11 11:19 UTC by Stewart Gordon
Modified: 2024-12-13 17:59 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description Stewart Gordon 2012-03-11 11:19:44 UTC
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.
Comment 1 Stewart Gordon 2012-10-27 07:50:44 UTC
(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).
Comment 2 Andrej Mitrovic 2012-11-02 01:28:10 UTC
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.
Comment 3 dlangBugzillaToGithub 2024-12-13 17:59:04 UTC
THIS ISSUE HAS BEEN MOVED TO GITHUB

https://github.com/dlang/dmd/issues/18425

DO NOT COMMENT HERE ANYMORE, NOBODY WILL SEE IT, THIS ISSUE HAS BEEN MOVED TO GITHUB