Errors with global variable documentation
boombatower - February 14, 2008 - 20:56
| Project: | API |
| Version: | 5.x-1.0 |
| Component: | Code |
| Category: | bug report |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | duplicate |
Jump to:
Description
I recently received an e-mail from aclight who noticed that the global variable documentation seems to have a few issues. I completed the task to create the documentation and everything seemed to be in order.
On the globals documentation page the @see tag seems to be displayed incorrectly. I'm not sure if this applies to all the documentation or just that page. For example:
<?php
/**
* Stores timers that have been created by timer_start().
*
* @see timer_start
* @see timer_read
* @see timer_stop
*/
global $timers;
?>generates:
Stores timers that have been created by timer_start(). See alsotimer_start
Not only is there no space between See also and the related function, but the other three @see tags seemed to have been ignored.
I'm not sure if there is an issue in the way the documentation is generated or in the way I documented.
#1
This is a bug in the API module which generates the API documentation. I think that a.d.o uses 5.x, but I'm not completely sure.
#2
I don't know if this is the same error, but at api.drupal.org under globals for 5x and 4.7 they are completely blank.
#3
@Aaron-Hawkins: I wrote the global documentation for 6.x so that would make sense.
#4
@see generally needs to be fixed: http://drupal.org/node/263663