Somehow provide a link from api.d.o topics back to the associated documentation on d.o. For example, there's quite a bit of good information at http://drupal.org/node/37775 on the Form API which topic pages like api.drupal.org/api/drupal/includes!form.inc/group/form_api/7 could link to.

I apologize if this is the wrong place to post this issue. Please forward.

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Category: feature » support
Status: Active » Fixed

Thanks for this suggestion... The documentation on api.drupal.org is generated from comments in the Drupal Core source code... which means that any links to be displayed have to be put into the Drupal Core source code comments that generate that particular page.

So if you have specific suggestions for a link that should be on a specific page, click the "file an issue" link on the api.drupal.org page and make your suggestion for that specific page. Each one has to be done manually.

This issue contains a specific suggestion, but actually the link from
http://api.drupal.org/api/drupal/core!includes!form.inc/group/form_api/8
http://api.drupal.org/api/drupal/includes!form.inc/group/form_api/7
to
http://drupal.org/node/37775
already exists, near the bottom (the link title is "Form API documentation section").

Sborsody’s picture

Sborsody commented

Hehe, the Drupal 6 version doesn't have any such link. Since most recently I was using the D6 API, now I know why it seemed to be missing!

The link on D7 and D8 versions seem like they could be called out better. I don't really know the underlying code that generates the html from the doxygen commands for display on api.drupal.org, but would it be possible to create some additional markup to put those "more information" links into their own boxes/section/whatever?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Sections - not currently possible on api.drupal.org, but it may be added as a feature soon. See
#996242: Support @ref, @section and @subsection tags
(the API module generates the pages).

Drupal 6 version not having links - you can feel free to file an issue (click on the issue link at the bottom of the page). :)

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.