ccbe95fd8a
`gn format` recently [1] changed its formatting behavior for deps, source, and a few other elements when they are assigned (with =) single-element lists to be consistent with the formatting of updates (with +=) with single-element. Now that we've rolled in a GN binary with the change, reformat all files so that people don't get presubmit warnings due to this. CL generated with: $ git ls-files | grep BUILD.gn | xargs gn format $ gn format build_overrides/build.gni $ gn format build_overrides/gtest.gni $ gn format modules/audio_coding/audio_coding.gni $ gn format webrtc.gni $ gn format .gn Plus a few manual changes to add exceptions for "public_deps" (after changing these lines the presubmit started to complain). [1] - https://gn-review.googlesource.com/c/gn/+/6860 Bug: webrtc:11302 Change-Id: Iac29d23c1618ebef925c972e2891cd9f4e8cd613 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/166882 Reviewed-by: Patrik Höglund <phoglund@webrtc.org> Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org> Cr-Commit-Position: refs/heads/master@{#30334}
How to write code in the api/ directory
Mostly, just follow the regular style guide, but:
- Note that
api/code is not exempt from the “.hand.ccfiles come in pairs” rule, so if you declare something inapi/path/to/foo.h, it should be defined inapi/path/to/foo.cc. - Headers in
api/should, if possible, not#includeheaders outsideapi/. It’s not always possible to avoid this, but be aware that it adds to a small mountain of technical debt that we’re trying to shrink. .ccfiles inapi/, on the other hand, are free to#includeheaders outsideapi/.
That is, the preferred way for api/ code to access non-api/ code is to call
it from a .cc file, so that users of our API headers won’t transitively
#include non-public headers.
For headers in api/ that need to refer to non-public types, forward
declarations are often a lesser evil than including non-public header files. The
usual rules still apply, though.
.cc files in api/ should preferably be kept reasonably small. If a
substantial implementation is needed, consider putting it with our non-public
code, and just call it from the api/ .cc file.