• Home
Name Date Size #Lines LOC

..--

README.mdD12-May-2024960 1913

README.md

1# Boost.GIL Clang-Format
2
3This is an _example_ of `.clang-format` file which offers _good enough_
4configuration and may be _useful_ when writing code for GIL, not required though.
5
6This is **not** a complete configuration!
7
8It does not cover all the recommended or preferred ways of formatting the code for GIL.
9It may be necessary to manually tweak the formatting generated by this `.clang-format` file.
10For example, there is a bug in clang-format that does not allow spacing and breaking
11trailing return types properly ([here](http://lists.llvm.org/pipermail/cfe-users/2018-November/001421.html)
12and [here](https://stackoverflow.com/a/57279663/151641)).
13More in details can be found in the [brainstorm of .clang-format proposal](https://github.com/boostorg/gil/pull/87).
14
15It has been successfully used with clang-format 8 or later.
16
17If you wish to use this file with `clang-format`, copy it to the root directory of GIL
18sources, to `libs/gil/.clang-format`.
19