search

gcode-mirror / google-highly-open-participation-drupal

Automatically exported from code.google.com/p/google-highly-open-participation-drupal
0 stars 0 forks source link

Add PHP documentation to FAQ and Avatar Selection modules #97

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
This task is to ensure that all functions, classes, methods, and constants
in the FAQ and Avatar Selection modules have properly formed, complete
Doxygen code comments.

Doxygen is the documentation generation system that Drupal uses. The
documentation is extracted directly from the sources, which makes it much
easier to keep the documentation consistent with the source code. The
documentation should contain information that is helpful to developers who
may not be familiar with the code, such as explaining what functions do,
how functions should be called and what information the different
parameters contain. Developers often need need to check the API
documentation when creating patches or developing new features and so it is
important to have clear, correct documentation.

To complete this task, review the two modules and add API documentation to
any function, class, method, or constant that does not have it or expand on
existing documentation where it is incomplete, unclear, or does not follow
established Drupal standards. See the resources section for more
information, particularly the "Drupal Doxygen formatting conventions".

The final deliverable will be a set of 2 patches against the 6.x versions
of the FAQ and Avatar Selection modules posted to the issue queue that has
been reviewed and marked "Ready to be Committed".

Resources
 * Drupal Doxygen formatting conventions - http://drupal.org/node/1354
 * Drupal Coding Standards - http://drupal.org/coding-standards
 * http://www.stack.nl/~dimitri/doxygen/docblocks.html
 * http://www.stack.nl/~dimitri/doxygen/commands.html
 * FAQ project page - http://drupal.org/project/faq
 * Avatar Selection project page - http://drupal.org/project/avatar_selection

Original issue reported on code.google.com by power.st...@gmail.com on 14 Dec 2007 at 10:51

GoogleCodeExporter commented 9 years ago 
Please post all of your work to the drupal.org issue at 
http://drupal.org/node/200879

Original comment by acli...@gmail.com on 14 Dec 2007 at 12:09

GoogleCodeExporter commented 9 years ago 
Owner is Stella Power (snpower - http://drupal.org/user/66894)

Original comment by power.st...@gmail.com on 14 Dec 2007 at 2:30

GoogleCodeExporter commented 9 years ago 
 i claim this task

Original comment by daryenna...@gmail.com on 18 Dec 2007 at 9:45

GoogleCodeExporter commented 9 years ago 
Ok daryennaruto, this task is yours.  Please post your work as well as any 
questions
to the drupal.org issue for this task at http://drupal.org/node/200879

Original comment by acli...@gmail.com on 18 Dec 2007 at 10:48

GoogleCodeExporter commented 9 years ago 
@daryennaruto:  Have you made any progress on this task yet? It would be best 
if you
could go ahead and post whatever work you have completed so far in the 
drupal.org
issue tracker at http://drupal.org/node/200879 so that we can make sure that 
you're
on the right track.

Original comment by acli...@gmail.com on 24 Dec 2007 at 4:31

GoogleCodeExporter commented 9 years ago 
daryennaruto we'll need to see some response or we'll need to reopen the task.

Original comment by addi.be...@gmail.com on 31 Dec 2007 at 12:58

GoogleCodeExporter commented 9 years ago 
Shoot. :( Student still hasn't responded, so setting back to Open.

Original comment by webchick...@gmail.com on 2 Jan 2008 at 8:29

GoogleCodeExporter commented 9 years ago 
I would like to claim this task

Original comment by andrei.r...@gmail.com on 22 Jan 2008 at 5:10

GoogleCodeExporter commented 9 years ago 
Sorry, but you have to use the exact phrase "I claim this task" to claim a 
task. 
It's in the official rules.

If you respond with that phrase within the next few hours (before the deadline 
to
claim tasks at midnight pacific standard time on Jan 22) then the task is 
yours, but
you have to respond with that exact phrase.

Original comment by acli...@gmail.com on 22 Jan 2008 at 5:13

GoogleCodeExporter commented 9 years ago 
I claim this task

Original comment by andrei.r...@gmail.com on 22 Jan 2008 at 6:11

GoogleCodeExporter commented 9 years ago 
Great, here you go. :)

Please post your work and any follow-up questions to 
http://drupal.org/node/200879

Original comment by webchick...@gmail.com on 22 Jan 2008 at 6:27

GoogleCodeExporter commented 9 years ago 
Oops. Forgot a tag.

Original comment by webchick...@gmail.com on 22 Jan 2008 at 6:27

GoogleCodeExporter commented 9 years ago 
I just wanted to check in and see how this task is coming along.  Could you 
please
post the progress you've made so far to the issue for this task on drupal.org 
please,
so we can make sure you're on the right track.

Now that it's too late to claim another issue, we'll allow you to work on this 
task
until the final deadline of midnight PST on Feb. 4, 2008.  However, tasks must 
be
*reviewed* by this deadline as well, so it would be great if you could get your 
work
to us as soon as possible so we can start the review process.

Thanks

Original comment by acli...@gmail.com on 26 Jan 2008 at 3:53

GoogleCodeExporter commented 9 years ago 
I will try to send you all the modified sources, as soon as I finished them, 
for each
module. For the moment I started reviewing (and writing what it seems to be 
missing)
the FAQ module.
Files coming when finished:D

Original comment by andrei.r...@gmail.com on 29 Jan 2008 at 4:18

GoogleCodeExporter commented 9 years ago 
By the way, I suppose I should work only on .module files, right? Or on 
.install too?

Original comment by andrei.r...@gmail.com on 29 Jan 2008 at 4:54

GoogleCodeExporter commented 9 years ago 
You should do it for both the .module and the .install file.
Cheers,
Stella

Original comment by power.st...@gmail.com on 29 Jan 2008 at 5:06

GoogleCodeExporter commented 9 years ago 
Thanks, will do

Original comment by andrei.r...@gmail.com on 29 Jan 2008 at 7:29

GoogleCodeExporter commented 9 years ago 
Still waiting to hear from you on this. There are 3 days left to go to get this 
work
completed, reviewed, and marked complete. Unless you submit something in the 
next 24
hours, that's not likely to happen. :(

Original comment by webchick...@gmail.com on 31 Jan 2008 at 11:01

GoogleCodeExporter commented 9 years ago 
Ok, until this evening (I am GMT+2) you will have at least the FAQ modules 
completed.
I will post them on the drupal issue page

Original comment by andrei.r...@gmail.com on 1 Feb 2008 at 3:02

GoogleCodeExporter commented 9 years ago 
Some work has been posted to the issue queue for this task, so I'm setting it as
NeedsReview.

Original comment by acli...@gmail.com on 1 Feb 2008 at 3:51

GoogleCodeExporter commented 9 years ago 
@andrei:  Is this blog posting yours?
http://english-blog.kappakid.net/2008/02/02/ghop-terminated-me/

If so, I would suggest that you change the title or add an update to this.  I'm 
not
sure if you are a native English speaker, but a title of "GHop terminated me" 
implies
that we have kicked you off of this task or out of the GHOP program.  That's
certainly not the case here.  I agree that Stella pointed out quite a few 
things that
need to be fixed in your patch, but since most of them are minor points it 
hopefully
won't take you *too* long to finish them.

If you feel that the review is unfair, please drop into the #drupal-ghop IRC 
channel
on irc.freenode.net and talk with me (aclight) so that we can get this cleared 
up.

I look forward to you finishing this task up, as it seems you will.  You've 
done a
lot of work for this task but I hope you've enjoyed it and learned something :)

Original comment by acli...@gmail.com on 2 Feb 2008 at 4:26

GoogleCodeExporter commented 9 years ago 
@aclight: I am sorry for the title, didn't want to offend anyone or anything. 
As I
explained there in the post (somewhere), I was talking about the work, which I 
did in
the last 3-4 days, and it was from 9 AM in the morning, till 2-3 AM in 
the...morning:D
About the title, I changed it, not the url (it may cause bad behaviour with 
google,
technorati & co). About my English: I am born in Romania, and I still live here.
English is my 2nd language, and it is far from perfect.
Now I will post on drupal page all the project files (documented), and the 
patches,
as 'diff' gave me.

Original comment by andrei.r...@gmail.com on 3 Feb 2008 at 1:20

GoogleCodeExporter commented 9 years ago 
@andrei:  No worries.  I mostly wanted to make sure you didn't think that we had
kicked you off the task.  I can see that you've put a lot of work into this, 
and we
do appreciate that.

Original comment by acli...@gmail.com on 3 Feb 2008 at 3:54

GoogleCodeExporter commented 9 years ago 
This is very close to finished.  I have posted some notes on the issue:

http://drupal.org/node/200879

Cleaning these up should take less than an hour.  In general, the English in the
documentation is quite good.

Original comment by agentric...@gmail.com on 3 Feb 2008 at 4:15

GoogleCodeExporter commented 9 years ago 
I went ahead and uploaded the student's work in case he's asleep already.  
Great job
with this.  Thanks for all of your hard work.

Original comment by acli...@gmail.com on 3 Feb 2008 at 10:24

Attachments:

GoogleCodeExporter commented 9 years ago 
@aclight: thanks, I was just on my way to sleep
All the best!

Original comment by andrei.r...@gmail.com on 3 Feb 2008 at 10:35

GoogleCodeExporter commented 9 years ago 
Drupal Theme Developer, is a best Drupal Theme web developing firm in India. We 
build
<br><br>affordable web for best price. We develop Drupal projects for any web  
and
web pages. We do, Drupal <br><br>Outsourcing project, PHP & Mysql outsource web
development. http://www.drupal-web-developers.com/drupal-theme-development

Original comment by dhanasek...@gmail.com on 20 May 2009 at 10:20