Files
platform-external-webrtc/api
Mirko Bonadei 61b4f7489d Fix PeerConnectionInterface::StartRtcEventLog documentation.
Logging will not stop after 10 minutes but after the max size of the
file is reached.

Bug: None
No-Try: True
Change-Id: I18c064cc60b52d892d5070b3eddf08749b60604c
Reviewed-on: https://webrtc-review.googlesource.com/c/121959
Reviewed-by: Björn Terelius <terelius@webrtc.org>
Reviewed-by: Karl Wiberg <kwiberg@webrtc.org>
Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#26625}
2019-02-11 08:00:39 +00:00
..
2019-02-08 14:45:00 +00:00
2019-01-25 20:29:58 +00:00
2019-02-01 13:24:47 +00:00

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 “.h and .cc files come in pairs” rule, so if you declare something in api/path/to/foo.h, it should be defined in api/path/to/foo.cc.
  • Headers in api/ should, if possible, not #include headers outside api/. 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.
  • .cc files in api/, on the other hand, are free to #include headers outside api/.

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.