Skip to content

Place clang-format off/on guards before/after every YADE_CLASS_BASE_DOC_* macro.

Janek Kozicki requested to merge clangOnOffGuards into master

Note: the sooner we merge this one, the fewer conflicts it will have in future rebases.

This commit simply adds the // clang-format off and // clang-format on guards before and after YADE_CLASS_BASE_DOC_* because I checked clang-format manual and there is no way to tell clang format to reformat this macro in any useful way. There is an option in clang to recognize that docstrings are written in restructured text format. But the support is too limited to be useful for us.

I think it is better to separate this commit from !298 (merged), because that one should have:

  • documentation
  • script that helps people to reformat stuff
  • .clang-format settings which are most compatible with current codebase, like Anton started searching already.

But it should not contain actual reformatting changes, because that would be a noise which would make it difficult to verify that documentation is updated properly etc.

Merge request reports