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 approximately 143 public API comments in LIBRT files starting with a 'd' (e.g., src/librt/db_tree.c) that need to be moved. This will find most of them: grep -n -r -E '^/\*\*' src/librt | grep -v svn | grep -v '\*\*\*' | grep -v '@' |grep 'librt/d' ONLY move comments on functions that have a corresponding RT_EXPORT declaration in the include/raytrace.h header. It should take less than 30 seconds to review each one. Code:
|
| File name/URL | File size | Date submitted | |
|---|---|---|---|
| ModifiedFiles.zip | 140.7 KB | November 30 2012 11:19 UTC | |
| my.patch | 89.1 KB | November 30 2012 11:44 UTC |
I would like to work on this task.
This task has been assigned to Edward Kalfov. You have 48 hours to complete this task, good luck!
This task has been Reopened.
Edward,
Sorry for the confusion -- this task wasn't supposed to be published. There's still another even shorter comment-moving task available here:
http://www.google-melange.com/gci/task/view/google/gci2012/8025209
I would like to work on this task.
This task has been assigned to Ambar Pal. You have 48 hours to complete this task, good luck!
How do I install BRL-CAD on windows 7?
I found some info here http://brlcad.org/wiki/Deuces but I cannot understand what to do after point 2. Please Explain.
This task requires a source checkout of BRL-CAD. You'll need to download a Subversion client for Windows and use that to check out https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk
From there, you'll be able to edit the source files and make a patch of the moved comments.
Thanks, so I need not download the image file whose link is provided at http://brlcad.org/wiki/Deuces.
You certainly can download the disk image and virtual machine described on the Deuces page. That will provide you a completely set up Linux environment to work in that has everything already installed and ready to go. The page where you downloaded the disk image had much more detailed instructions on what to do with setting up the image within VirtualBox.
" The comments need to be moved from .c source code files to the corresponding .h API header file "
Suppose I have got a function in the d*.c/d*.h files which is defined with RT_EXPORT. I goto the comment for the function, copy it. Where do I paste it now?
Exactly what you just wrote. You find a /** */ comment for a function in a .c source file and move it to where the function is declared in the .h header file. You're not doing copy-n-paste, you're doing cut-n-paste. cut from c, paste into h. do that for all of the functions that have an RT_EXPORT declaration.
So I installed the image that was provided and then ran
on the terminal. However, it says src/librt not found. Excuse me if this is a really silly question because i am totally new to linux but BRL CAD seems interesting and therefore i am trying all this.
It takes time to change to linux from windows. I just had to cd to the brlcad-svn directory.
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 ,you have succesfully completed the task. Your work has been applied in revision r53914. If you wish, please leave your name so you can be credited in our autorship for your contribution.
Congratulations, this task has been completed successfully.
My name is Ambar Pal.
As GCI comes to a close, we wanted to take the time to say THANK YOU for all your efforts. This comment interface closes after GCI is over, so you're encouraged to join our mailing list where we'll be announcing contributions from GCI participants like yourelf over the upcoming months:
https://lists.sourceforge.net/lists/listinfo/brlcad-news
If you've provided your full name, we'll be sure to credit you in our authorship documentation and you'll see your name in a future announcement. If you contact us at devs@brlcad.org or via IRC, we'll even let you know when your work is integrated and follow up with updates. You're welcome and encouraged to contact us any time, especially if you have a question about how to continue participating in Open Source after GCI is over, but even if just to keep in touch. Note that ongoing participation in Open Source is one of the most impressive skills to have on your resumé. Take care, be well, and thank you again!