Hi,

I found a small issue in http://api.drupal.org/api/function/template_preprocess_page/6 ,
where links labeled "page.tpl.php" lead to http://api.drupal.org/api/file/themes/pushbutton/page.tpl.php/6 ,
while the text mentions a reference to "modules/system/page.tpl.php" .

The documentation being generated by doxygen, I realised that the problem was caused by homonym files, inherent to Drupal OO-like architecture.
I'm not aware of a way to specify destination links for doxygen, in source documentation blocks.

I did a few tests with my doxygen (v. 1.5.8), and I found that the double quotes around full path name prevented the link to be generated.

Replacing patterns like

... own copy of page.tpl.php. The default is located inside "modules/system/page.tpl.php"

with

... own copy of @em page.tpl.php. The default is located inside modules/system/page.tpl.php

shows the first filename "emphasized" (no link there anyway with my doxygen version, maybe because of duplicate names), and the second as a link to the intended destination page.
Another option would be:

... own copy of @em "page.tpl.php". The default is located inside modules/system/page.tpl.php

which would prevent the false link if it was generated on your platform.

I enclose the corresponding patches.

I filed this issue in Drupal project, and not documentation, because the origin and solution stays in core source files, not the website.

Comments

RockyRoad’s picture

Thanks to Dimitri on doxygen-users list for this tip, if you prefer:

You can do this using @ref and specify enough of the path to make the
reference unique,
i.e in your example it would be

/** See @ref system/page.tpl.php "modules/system/page.tpl.php" for
more info */

But just specifying the file name with relative path without quotes
should also have worked, i.e.

/** See modules/system/page.tpl.php for more info */

Regards,
Dimitri

Status: Active » Closed (outdated)

Automatically closed because Drupal 6 is no longer supported. If the issue verifiably applies to later versions, please reopen with details and update the version.