Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
AStyle : drivers/hal/platform folders update #7008
This depends on #7007 (first 2 commits here are from that PR, will be rebased) . Applied to drivers/hal/platform folders. Up for review to see how astyle formats the code .
Not critical for 5.9, can come right after the code freeze so wont cause much rebasing (styling changes, should not change any behavior!)
This will need to be rebase as there are couple of PR changing this folders, will do final rebase once approved, thus please look at changes to check the style - the very important
Pull request type
A couple of comments and questions, one of which I really care about.
There is some inconsistencies with block comments for functions and structure members.
For example the comments lines 84-85 in
Driver_Storage.h should be aligned with the comment line 83 as they are part of the same member documentation.
Also I know it is part of K&R but as we already have 2 exceptions to the rules, one for the function's opening brace's new line would be good to me.
The line return doesn't help much readability while artificially increasing LOC count.
It should be consistent with other blocks indentation (
If I change the style for the comment, this stays as it is (line 2 is intentionally misalinged to check if it aligns it or leaves it) :
From the astyle docs: no doxygen mentioned in the documentation (no option there available). There are 3 tickets in the issue tracker that are related to doxygen, none resolved. I assume AStyle treats ///< as a code comment (
It touches CRC header file just because it uses 5 spaces so aligns it to 4. But does not touch comments (no doxygen support). Looks fine. Formatting doxygen is out of scope for AStyle.
To resolve the Storage problem, either ignore that file (its deprecated anyway, I should probably not do any style changes. I'll revert them) or use other doxygen formatting (as shown above
I dont follow.
Build number : 2477
Build number : 2116