Update comments to be consistent

[janaakhterov]

Description:

Update comments to follow the same style; that style being Javadoc style:

/**
 * <comment>
 */

Related issue(s):

Notes for reviewer:

Checklist

• Documented (Code comments, README, etc.)
• Tested (unit, integration, etc.)

[steven-sheehy]

Glanced through and it looked fine. Just clarifying if this change was done using an automated process? If so, that gives me high confidence that there wouldn't be any copy and mistake errors.

[janaakhterov]

@steven-sheehy the process I used was to use VIM's built in comment formatter and macros. I would simply select the region to format and then hit a macro which would convert // into *, put /** before the selected region, and */ at the end of the selected region. Of course not all comments were formatted originally to start with // so I had to properly choose which macro to use. I've also use a little regex to format one line comments such as /* .* */. So this process wasn't completely automated, but it wasn't completely manual with copy and pasting either.

Big reason I had in my mind that this doesn't need to be completely automated is because this ideally shouldn't be an issue anymore. I'm hoping that if anyone reads the protobufs they'd be able to see the style guide for comments and follow it. I'm hoping that soon enough buf will have a built in formatter which we'd use instead of writing our own.

[janaakhterov]

Seems like I got a bit of rebasing to do.

[steven-sheehy]

LGTM

[tinker-michaelj]

LGTM!