Menu
Logged-In As
ACCOUNTNot Logged In
Move comments from source to header files ... move LIBBN commentsBRL-CAD
Status: ClosedTime to complete:
48 hrs
Mentors: Sean, Erik
BRL-CAD uses Doxygen source code comments to document the API. The comments need to be moved from .c source code files to the corresponding .h API header file. Note that this is a REALLY easy task, it is just cut-and-paste after all, so it just might take you more than a couple hours if you're inefficient with a text editor. Regardless, you must make sure you compile before and after to make sure you didn't introduce a typo because you're changing so many files. There are less than 150 API comments across 17 files in LIBBN that need to be moved. This will find most of them: grep -n -r -E '^/\*\*$' src/libbn | grep -v svn | grep -v '\*\*\*' | grep -v '@' ONLY move comments on functions that have a corresponding BN_EXPORT declaration in the include/bn.h header. It should take less than 30 seconds to review each one. Code:
|
Uploaded Work
| File name/URL | File size | Date submitted | |
|---|---|---|---|
| final.patch | 169.6 KB | November 27 2012 15:23 UTC | |
| patch+notes.tar.gz | 42.3 KB | November 28 2012 12:45 UTC |
I would like to work on this task.
This task has been assigned to Skriptkid. You have 48 hours to complete this task, good luck!
I didn't quite understand where in the header files the comments need to be moved to. Could you please explain that part?
I see you were helped on irc. do you understand what is needed now or do you still need more explanation?
Understood :)
I need to submit my work. So do I just create a patch file as shown on the wiki and upload it on the task page or should I submit it on Sourceforge? If on Sourceforge, do I have to mention that it's a GCI task?
you can just submit the patch file here
The work on this task is ready to be reviewed.
Any idea how long reviewing might take?
We're allowed up to 36 hours, but it shouldn't be more than a few hours. I can't be more specific yet because we're just getting started. Right now, there are just a couple submitters in the queue ahead of you.
One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.
The patch seems to be made against an old version (49726, from march 16th, 2012) and does not apply cleanly against recent revisions (53834). Please 'svn up' to the latest, fix the conflicts, review the results and regenerate the patch file.
The most recent version is 53844. I'm working on that. Is it fine? Or is 53834 required?
Yes, that's fine -- the point is to create a patch that will apply against the latest without any problems so your changes can be more easily reviewed and integrated.
I saw the revision history on Sourceforge and it said, Apply the comment migration by SkriptKid for the GCI project.
So all I need to do now is check for conflicts, updates, deletions in the new revision of LIBBN and edit bn.h accordingly right?
That commit was for the librt changes you made. For these libbn changes, yes I believe that was the same issue.
I see the confusion. He credited you in the commit message, but that was a patch from someone else (silvrous). We'll credit the right person in our documentation.
Provide your full name when you submit your patch (or here in comments), and we'll credit you as well.
Name's "Akshay Kashyap."
The new, revised patch is in the file "patch+notes.tar.gz." "final.patch" was the old one.
The work on this task is ready to be reviewed.
Melange has detected that the deadline has passed and no more work can be submitted. The submitted work should be reviewed.
Congratulations, this task has been completed successfully.
That was really fantastic work. Nicely done! What can we get you to work on next just like that?? :)
Thanks! :D Hadn't really expected that! Guess I'll do the surface area functions implementation next! :)