search

utra-robosoccer / soccer-embedded

Collection of embedded programs for an autonomous humanoid soccer robot
http://utrahumanoid.ca
32 stars 8 forks source link

Update Udp identifiers, rename hardware and mock filenames/classes, remove filename from @file and add script for it #194

Closed rfairley closed 5 years ago

rfairley commented 5 years ago

Script ran with python clear_doxygen_file_tags.py C:\Users\rob\soccer-embedded\Common.

The script is quite primitive in that it is only checking for one regex and replacing with * @file. In some cases a manual edit to remove the extra space was needed as some files indent the top doxygen comment with 2 spaces, others with 1 (e.g. I2CInterface.h vs OsInterface.h). Hopefully scripts like this, once tested enough, can become useful in our tooling for automatic format checking.

Resolves: #159

rfairley commented 5 years ago

This does work for #159 and #161 .

rfairley commented 5 years ago

Fixed, and did one more change to rename the test files after a final scan of https://github.com/utra-robosoccer/soccer-embedded/blob/master/CONTRIBUTING.md#naming-scheme-summary. Think we got the most prominent identifiers fixed - I'm :+1: with closing #159 after this.

rfairley commented 5 years ago

Edit: I think #161 will need a bit more work because ideally we should have all groups defined in their headers (no more awkward group names like HeaderXXX or XXXHeader). I think those changes would be good to do after we pull in the current PR, since this is the last of the code changes

Agreed

tygamvrelis commented 5 years ago

Fixed, and did one more change to rename the test files after a final scan of https://github.com/utra-robosoccer/soccer-embedded/blob/master/CONTRIBUTING.md#naming-scheme-summary. Think we got the most prominent identifiers fixed - I'm 👍 with closing #159 after this.

Okay, you verified that the tests still build after doing this, right?

rfairley commented 5 years ago

Yep - verified they build! (and that they pass)