Difference between revisions of "Comment Conventions"

From reSIProcate
Jump to navigation Jump to search
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
reSIProcate projects use [http://www.stack.nl/~dimitri/doxygen/ doxygen] comments in the interface (.hxx) files only.
 +
 
Inside the resip, dum, and repro code, you'll often come across comments that look something like this:
 
Inside the resip, dum, and repro code, you'll often come across comments that look something like this:
  
Line 11: Line 13:
 
The initials that you'll find in the code currently include:
 
The initials that you'll find in the code currently include:
  
* abr - Adam Roach <adam@nostrum.com>
+
* abr - Adam Roach (adam) <a d a m a t n o s t r u m d o t c o m>
* ah  - Alan Hawrylyshen <alan@jasomi.com>
+
* ah  - Alan Hawrylyshen (alan) <a l a n a t p o l y p h a s e d o t c a>
* ass -
+
* amr - Aron Rosenberg (arosenberg)
* cj  - Cullen Jennings <fluffy@cisco.com>
+
* bwc - Byron Campen (bcampen) < b c a m p e n a t e s t a c a d o d o t n e t>
* dcm - Derek McDonald <derek@xten.com>
+
* cj  - Cullen Jennings (fluffy) <f l u f f y a t c i s c o d o t c o m>
* dlb - David Butcher <david@pss.com>
+
* dcm - Derek McDonald (derek) <d e r e k a t x t e n d o t c o m>
* jf  - Jason Fischl <jason@iii.ca>
+
* dlb - david Butcher (dlb) <d a v i d a t p s s d o t c o m>
* kh  - Ken Ho <kenho@teltel.com>
+
* jf  - Jason Fischl (jason) <j a s o n a t  i i i d o t c a >
* kk  - Ken Kittlitz
+
* kh  - Ken Ho (kenho) <k e n h o a t t e l t e l d o t c o m>
* RjS - Robert Sparks <rjs@nostrum.com>
+
* kk  - Ken Kittlitz (ken?) < k k i t t l i t z a t d i t e c h n e t w o r k s d o t c o m>
* rk
+
* RjS - Robert Sparks (rjsparks) <r j s a t n o s t r u m d o t c o m >
* rm  - Rohan Mahy <rohan@ekabal.com>
+
* rk - Ryan Kereliuk (ryker) < r y k e r a t r y k e r d o t o r g >
* rwm - Rohan Mahy <rohan@ekabal.com>
+
* rm  - Rohan Mahy (rohan) <r o h a n a t  e k a b a l d o t c o m>
* slg - Scott Godin <slgodin@icescape.com>
+
* rwm - Rohan Mahy  
 +
* slg - Scott Godin (sgodin) < s g o d i n a t s i p s p e c t r u m d o t c o m >

Latest revision as of 15:13, 23 February 2013

reSIProcate projects use doxygen comments in the interface (.hxx) files only.

Inside the resip, dum, and repro code, you'll often come across comments that look something like this:

// !abc! This needs to be updated to handle timeouts

The tag that precedes the comment (!abc! in this example) represents which developer inserted the comment, and the nature of the comment. These come in three flavors:

  • // !abc! - This comment calls out something that needs to be fixed
  • // ?abc? - This comment asks a question; feel free to contact the comment author if you know the answer to the question.
  • // .abc. - This is simply an attributed comment

The initials that you'll find in the code currently include:

  • abr - Adam Roach (adam) <a d a m a t n o s t r u m d o t c o m>
  • ah - Alan Hawrylyshen (alan) <a l a n a t p o l y p h a s e d o t c a>
  • amr - Aron Rosenberg (arosenberg)
  • bwc - Byron Campen (bcampen) < b c a m p e n a t e s t a c a d o d o t n e t>
  • cj - Cullen Jennings (fluffy) <f l u f f y a t c i s c o d o t c o m>
  • dcm - Derek McDonald (derek) <d e r e k a t x t e n d o t c o m>
  • dlb - david Butcher (dlb) <d a v i d a t p s s d o t c o m>
  • jf - Jason Fischl (jason) <j a s o n a t i i i d o t c a >
  • kh - Ken Ho (kenho) <k e n h o a t t e l t e l d o t c o m>
  • kk - Ken Kittlitz (ken?) < k k i t t l i t z a t d i t e c h n e t w o r k s d o t c o m>
  • RjS - Robert Sparks (rjsparks) <r j s a t n o s t r u m d o t c o m >
  • rk - Ryan Kereliuk (ryker) < r y k e r a t r y k e r d o t o r g >
  • rm - Rohan Mahy (rohan) <r o h a n a t e k a b a l d o t c o m>
  • rwm - Rohan Mahy
  • slg - Scott Godin (sgodin) < s g o d i n a t s i p s p e c t r u m d o t c o m >