Make doxygen docs clearer for url(), and other minor doc fixes in common.inc

gpk - July 2, 2008 - 08:13
Project:Drupal
Version:6.x-dev
Component:documentation
Category:bug report
Priority:minor
Assigned:Unassigned
Status:closed
Description

Similar to #258475: Make doxygen docs clearer for l(). Go to http://api.drupal.org/api/function/url/7 to see the problem.

Also clarified a couple of other comments in common.inc and changed a couple of /* */ style comments to // style.

AttachmentSize
doxygen_url.patch5.03 KB

#1

gpk - July 2, 2008 - 08:17
Status:active» patch (code needs review)

Further tidied a couple of the comments (very minor).

AttachmentSize
doxygen-url-277604_0.patch5.03 KB

#2

gpk - July 2, 2008 - 08:23

Oh, I see that "C style comments (/* */)" are fine (http://drupal.org/coding-standards). Oh well, those 2 lines weren't perfect in any case ;)

#3

Dries - July 2, 2008 - 19:37
Status:patch (code needs review)» fixed

Committed to CVS HEAD. Thanks.

#4

gpk - July 3, 2008 - 08:20
Version:7.x-dev» 6.x-dev
Status:fixed» patch (reviewed & tested by the community)

Forgot to say - would be useful for D6 also IMO. Applies with offset. RTBC I guess?

#5

litwol - July 4, 2008 - 00:39
Version:6.x-dev» 7.x-dev
Status:patch (reviewed & tested by the community)» fixed

as far as i know things dont get backported unless its major security fix or something.

#6

gpk - July 4, 2008 - 09:10
Version:7.x-dev» 6.x-dev
Status:fixed» patch (reviewed & tested by the community)

@5: true (obviously!) that new features don't get backported, but most bugs and documentation fixes do get backported if applicable (e.g. the documentation for l(), as linked above in the original post) and committed if the community/relevant committer decide it also needs to be fixed in that version. :-D

#7

Gábor Hojtsy - July 8, 2008 - 09:56
Status:patch (reviewed & tested by the community)» fixed

OK, committed to 6.x for easier reading of API docs through the remaining D6 lifetime.

#8

Anonymous (not verified) - July 23, 2008 - 10:56
Status:fixed» closed

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

 
 

Drupal is a registered trademark of Dries Buytaert.