Re: [Live-devel] LIVE555 code standard: comments

2007-06-11 Thread Ross Finlayson
I notice in the class headers like RTSPClient the function description appears after the function. is it prefered to put the function explanation after or before the function? I usually put the function explanation after the function declaration - unless the explanation refers to more than one

Re: [Live-devel] LIVE555 code standard: comments

2007-06-11 Thread xcsmith
I notice in the class headers like RTSPClient the function description appears after the function. is it prefered to put the function explanation after or before the function?___ live-devel mailing list live-devel@lists.live555.com http://lists.live555.

Re: [Live-devel] LIVE555 code standard: comments

2007-06-07 Thread Ross Finlayson
When commenting LIVE555 code, is it prefered to have the comment blocks appear after the code block or function definition the comment block pertains to? It depends. If the comment is of the form // We're about to do X then I usually put it before. If the comment is of the form

[Live-devel] LIVE555 code standard: comments

2007-06-07 Thread xcsmith
When commenting LIVE555 code, is it prefered to have the comment blocks appear after the code block or function definition the comment block pertains to? I can't tell which is the prefered location. Are larger comment blocks using // prefered over /* */ ? What about Doxygen comments? ( /**