Ticket #286 (assigned enhancement)

Opened 2 years ago

Last modified 4 months ago

Add links to the page of the base/derived class

Reported by:	demise	Assigned to:	pragma (accepted)
Priority:	major	Milestone:	WebSite 1.0
Component:	Documentation	Version:
Keywords:		Cc:

Description

It would nice if the API documentation included links to base classes like Java API has. E.g. in

class SocketConduit? : tango.io.Conduit.Conduit;

the latter part would point to

http://www.dsource.org/projects/tango/docs/current/tango.io.Conduit.html

In Phobos this was not that important since all classes of the hierarchy were usually on the same page.

Change History

02/26/07 08:03:51 changed by larsivi

priority changed from minor to major.
milestone set to Documentation.

(follow-up: ↓ 3 ) 02/26/07 15:10:32 changed by JJR

owner changed from JJR to pragma.

This is a limitation appers to be part of the DDOC system? Perhaps we need a way to automate the process from the wiki side of things.

(in reply to: ↑ 2 ) 02/26/07 15:15:44 changed by JJR

Replying to JJR:

This is a limitation appers to be part of the DDOC system? Perhaps we need a way to automate the process from the wiki side of things.

Er... meant to say "This limitation appears to be part of the DDOC system"

Since the API docs are generated from the source code comments, somebody will have to find a way to fix this. Since the ddoc system is dependant on the D compiler, an alternative may to be to post-process this via the wiki?

02/26/07 16:17:39 changed by demise

I would just like Walter to add this feature to DDOC. Post-processing the documentation could be an alternative, but only as a workaround. I'm pretty sure there are also other projects that would like to document their code. Doxygen and others are still not as mature as DDOC in some areas, but even they have this feature.

06/21/07 05:49:50 changed by larsivi

milestone changed from Documentation to WebSite RC1.

04/30/08 13:25:33 changed by pragma

status changed from new to assigned.

I published a short version of what it would take for DDoc to get up to speed with this. I'm not sure how it'll be recieved:

http://www.digitalmars.com/webnews/newsgroups.php?art_group=digitalmars.D&article_id=70806

In essence, DDoc doesn't stream enough metadata to the doc processor, and passes too much data along as raw output. A quick survey of the frontend shows that a large amount of DDoc's output is simply straight fprintf("%s",foobar) kind of stuff, with no macro to wrap the output.

Ticket Navigation