[Home]

Summary:ASTERISK-03277: [patch] convertion //comments ---> /* comments */ to jive w/ coding-guidlines
Reporter:derrick (derrick)Labels:
Date Opened:2005-01-14 23:32:52.000-0600Date Closed:2008-01-15 15:21:54.000-0600
Priority:MinorRegression?No
Status:Closed/CompleteComponents:Core/General
Versions:Frequency of
Occurrence
Related
Issues:
Environment:Attachments:( 0) head_coments_v2.diff
( 1) head_comments.diff
( 2) stable_comments_v2.diff
( 3) stable_comments.diff
Description:find . -type f -name \*[.c,.h] -exec perl -pi -e 's/^\/\/(.*)/\/* $1 *\//' {} \;

then searching for  "line of code //comments" and fixing those few remaing lines to makre sure i didn't alter any http:// or agi:// lines.

also some lines were // comment */,  removed the extra */ after the perl alteration

proof read patch and don't see any mistakes, all code compiles.


****** ADDITIONAL INFORMATION ******

patches for CVS and STABLE from central time evening 20050115
Comments:By: derrick (derrick) 2005-01-14 23:34:10.000-0600

i apparently can't spell
By: Mark Spencer (markster) 2005-01-15 00:27:05.000-0600

I appreciate the thought, but //! and related comments have a special meaning for doxygen automatically created documentation.
By: derrick (derrick) 2005-01-15 11:37:41.000-0600

ahhh!  i was wondering why it was so common but i couldn't find anything on it.

no sweat it all, it only took about 10 minutes.
^D
By: Mark Spencer (markster) 2005-01-15 11:48:59.000-0600

Yes, but some of your changes are legitimate (i.e. the ones which do not begin //!)  also what is the story of the ixjuser.h changes which don't involve comments?

If you can resubmit the patch filtering out the //! ones that would be helpful.  Thanks!
By: Kevin P. Fleming (kpfleming) 2005-01-15 11:58:59.000-0600

doxygen works fine with /*!, see what I used in linkedlists.h.
By: Mark Spencer (markster) 2005-01-15 12:39:40.000-0600

Does it need to be contiguous (e.g. /*! vs. /* !) ?
By: nick (nick) 2005-01-15 12:56:34.000-0600

http://www.stack.nl/~dimitri/doxygen/docblocks.html seems to indicate only /*!.

Nick
By: Mark Spencer (markster) 2005-01-15 13:20:10.000-0600

Okay so can we get it to /*! */ then for those comments and /* */ for the rest then?  Also I've removed ixjuser.h since it appears to be unnecessary anymore.
By: derrick (derrick) 2005-01-15 17:22:45.000-0600

i also couldn't find whether a /* !  was legal for doxygen, so just removed the space.

perl -pi -e 's/^\+\/\*\s\!/\+\/\*\!/' stable_comments_v2.diff to remove the spaces and i manually removed the ixjuser stuff as well.  the non comment related alterations were aligning the columns and changing spaces to tabs so things would line up properly.  which i suppose possibly violates the coding guideline directly above the comments rule.....

hope that does the trick,
^D
By: Mark Spencer (markster) 2005-01-15 17:45:07.000-0600

Added to CVS, thanks!
By: Russell Bryant (russell) 2005-01-16 19:12:09.000-0600

The stable patch does not apply cleanly in most parts of the patch ...

I would be more than happy to put these changes in if you upload an updated patch.
By: Digium Subversion (svnbot) 2008-01-15 15:21:54.000-0600

Repository: asterisk
Revision: 4806

U   trunk/channel.c
U   trunk/channels/alaw.h
U   trunk/channels/chan_phone.c
U   trunk/db1-ast/hash/hash_func.c
U   trunk/formats/msgsm.h
U   trunk/include/asterisk/acl.h
U   trunk/include/asterisk/adsi.h
U   trunk/include/asterisk/alaw.h
U   trunk/include/asterisk/app.h
U   trunk/include/asterisk/callerid.h
U   trunk/include/asterisk/cdr.h
U   trunk/include/asterisk/channel.h
U   trunk/include/asterisk/channel_pvt.h
U   trunk/include/asterisk/cli.h
U   trunk/include/asterisk/config.h
U   trunk/include/asterisk/crypto.h
U   trunk/include/asterisk/features.h
U   trunk/include/asterisk/file.h
U   trunk/include/asterisk/frame.h
U   trunk/include/asterisk/image.h
U   trunk/include/asterisk/io.h
U   trunk/include/asterisk/logger.h
U   trunk/include/asterisk/module.h
U   trunk/include/asterisk/monitor.h
U   trunk/include/asterisk/pbx.h
U   trunk/include/asterisk/rtp.h
U   trunk/include/asterisk/sched.h
U   trunk/include/asterisk/tdd.h
U   trunk/include/asterisk/translate.h
U   trunk/include/asterisk/ulaw.h
U   trunk/include/asterisk/vmodem.h
U   trunk/say.c

------------------------------------------------------------------------
r4806 | markster | 2008-01-15 15:21:54 -0600 (Tue, 15 Jan 2008) | 2 lines

Repair // comments to /* */ comments (bug ASTERISK-3277)

------------------------------------------------------------------------

http://svn.digium.com/view/asterisk?view=rev&revision=4806