Move comments from source to header files ... move LIBWDB comments

Move comments from source to header files ... move LIBWDB commentsBRL-CAD

Status: ClosedTime to complete: 48 hrs Mentors: SeanTags: cut-n-paste, text editor, move comments

There are approximately 60 public API comments in LIBWDB files. This will find most of them:

grep -n -r -E '^/\*\*' src/libwdb | grep -v svn | grep -v '\*\*\*' | grep -v '@'

ONLY move comments that have a corresponding WDB_EXPORT declaration in the include/wdb.h header AND stub in placeholder /** */ comments for any declarations in the header still lacking a comment block. ALSO, remove any 'F U N C T I O N' names that are spaced out from the comments.

Note that this task is slightly different from the other comment-moving tasks. You have to clean up the comments while you move them because there are so few.

Code:

include/wdb.h
src/libwdb/*.c

Uploaded Work

File name/URL	File size	Date submitted
wdb_patch+notes.tar.gz	6.8 KB	November 29 2012 12:47 UTC
wdb_patch+notes.tar.gz	6.8 KB	November 30 2012 09:46 UTC

Comments

Sumit Shyamsukhaon November 27 2012 15:17 UTCTask Claimed

I would like to work on this task.

Sumit Shyamsukhaon November 27 2012 15:19 UTCClaim Removed

The claim on this task has been removed, someone else can claim it now.

Edward Kalfovon November 27 2012 20:47 UTCTask Claimed

I would like to work on this task.

Sean on November 27 2012 21:02 UTCTask Assigned

This task has been assigned to Edward Kalfov. You have 48 hours to complete this task, good luck!

Edward Kalfovon November 28 2012 14:17 UTCClaim Removed

The claim on this task has been removed, someone else can claim it now.

Skriptkidon November 29 2012 11:21 UTCTask Claimed

I would like to work on this task.

Harmanpreet Singh on November 29 2012 11:33 UTCTask Assigned

This task has been assigned to Skriptkid. You have 48 hours to complete this task, good luck!

Skriptkidon November 29 2012 12:05 UTCDoubt

Didn't understand the statement "ALSO, remove any 'F U N C T I O N' names that are spaced out from the comments."

Skriptkidon November 29 2012 12:27 UTCGot it

Got the answer on IRC.

Skriptkidon November 29 2012 12:47 UTCReady for review

The work on this task is ready to be reviewed.

Sean on November 30 2012 16:19 UTCTask Closed

Congratulations, this task has been completed successfully.

Sean on November 30 2012 16:22 UTCfantastic

I haven't tried compiling yet, but the patch looks fantastic. That's for the detailed notes on what you did too. Wasn't entirely keen on the libwdb/ prefix on the @file blocks, because we'll probably have to remove those, but the rest looked great. If you provide your real name, we'll credit you accordingly in our authorship documentation.

Sean on November 30 2012 16:27 UTCand I see that we already did

I thought I'd already added you, but I guess I mis-spelled your nickname looking for you. You're credited, Akshay. :)

Skriptkidon November 30 2012 16:39 UTCThanks :)

For listening on IRC and revieweing :) I can remove the prefix and submit a new patch, if you'd like. Shouldn't be really tedious.

Sean on November 30 2012 17:15 UTCnot worth it

It's not worth the time to make and review a patch for that. If you keep working on good code changes and get commit access granted, you can directly fix the files yourself.