nikon/CANopenNode
1
0
Fork 0
Code Activity Actions

Recommended C style and coding rules

Browse source
This commit is contained in:
Janez 2021-08-30 07:28:20 +02:00
parent ece65978d3
commit a5fb680c6c
2 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -65,8 +65,7 @@ Report issues on https://github.com/CANopenNode/CANopenNode/issues
Older discussion group is on Sourceforge: http://sourceforge.net/p/canopennode/discussion/387151/ Older discussion group is on Sourceforge: http://sourceforge.net/p/canopennode/discussion/387151/
Contributions are welcome. Best way to contribute your code is to fork a project, modify it and then send a pull request. Some basic formatting Contributions are welcome. Best way to contribute your code is to fork a project, modify it and then send a pull request. Please follow the [Recommended C style and coding rules](https://github.com/MaJerle/c-code-style), like indentation of 4 spaces, etc. There is also a `codingStyle` file with example.
rules should be followed: Linux style with indentation of 4 spaces. There is also a `codingStyle` file with example and a configuration file for `clang-format` tool.
CANopenNode flowchart CANopenNode flowchart

10
codingStyle
View file

@ -35,11 +35,11 @@ extern "C" {
* body at the end. * body at the end.
* *
* ###Style * ###Style
* - Style is based on Linux style * - Style is based on https://github.com/MaJerle/c-code-style
* - Indent size is 4. * - Indent size is 4 spaces, no tabs.
* - Spaces are used, not tabs. * - Line width is 80 characters.
* - More datails are defined in .clang-format file * - Some (old) code may not be formatted according to the rules. Try to avoid
* - Some (old) code is still not corectly formatted. (To not break git history.) * unnecessary changes based on individual taste.
* *
* ###Doxygen * ###Doxygen
* Documentation is generated by doxygen. * Documentation is generated by doxygen.