Make birthdays code more stardard compliant

MarcoR - December 15, 2007 - 10:27
Project:Birthdays
Version:5.x-1.x-dev
Component:Code
Category:task
Priority:normal
Assigned:MarcoR
Status:closed
Description

Especially comments on functions need to be improved. See http://cvs.drupal.org/viewvc.py/drupal/contributions/modules/api/README....

But also some less important naming conventions should be adopted (i.e. $output for themed html as return value).

I can take that in some says. Because this will change many places in the code, it's better to do that when no heavy development is going on then. So please submit your latest changes to cvs.

#1

maartenvg - December 15, 2007 - 10:50

There is no heavy development going on at the moment, nor are there plans for that in the near future, due to sickness.
Feel free to do what you suggested, because it's one of those to-dos I never can find the time for.

Thanks for your input!

#2

MarcoR - December 17, 2007 - 00:28

I was very happy that birthday module has improved so much compared from the last time I saw it. Reallly very good! I fixed the following:

- Function comments according to core drupal functions and api module

<?php
/**
* @desc headline
*/
?>

to
<?php
/**
* headline
*/
?>

- $str to $output

- $u to $user

- $values to $form_values (that should have fixed an issue where a form could not be set back to defaults)

- set some function comments except where I'm not sure what type the arguments would be

- other minor indentation issues

As far as I tried it's working as perfect as before. I think this is a good start for further develeopment.

AttachmentSize
birthdays.module-5.x-1.x-dev-issue-201196-code-formatting.patch 15.88 KB

#3

MarcoR - December 17, 2007 - 00:31
Status:active» needs review

I forgot: Also made a JavaScript improvement: FILTER Button is not shown if JavaScript is enabled. ;)

#4

MarcoR - December 17, 2007 - 09:53

It would be nice if some people could test this patch. Because so many lines have changed, going ahead with any other birthdays issue only makes sense when this patch has been committed. Thanks! :)

#5

maartenvg - March 26, 2008 - 22:26

Now that I'm getting well again, I'll look into your patch and commit it.

#6

maartenvg - April 8, 2008 - 21:43
Status:needs review» fixed

#7

Anonymous (not verified) - April 22, 2008 - 21:56
Status:fixed» closed

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

 
 

Drupal is a registered trademark of Dries Buytaert.