1676590 - Have a naming convention for forwarding headers

Status: NEW

(Developer Infrastructure :: Source Code Analysis, task, P3)

Description

[Simon Giesecke [:sg] [he/him]]

To make it easier to identify which headers are forwarding headers, i.e. which contain only forward declarations to types defined elsewhere, we should have and comply with a naming convention for such files.

At the moment, there are at least three different variants, leading to the following files, e.g.:

• https://searchfox.org/mozilla-central/search?q=Fwd.h&path=&case=false&regexp=false
• https://searchfox.org/mozilla-central/search?q=ForwardDeclare.h&path=&case=false&regexp=false
  https://searchfox.org/mozilla-central/search?q=TypeDecls&path=&case=false&regexp=false

Among these, the Fwd suffix is most widespread, and is also in line with the suffix used in the standard library by the <iosfwd> header. It would still be good to codify this in https://searchfox.org/mozilla-central/source/docs/code-quality/coding-style/coding_style_cpp.rst

Comment 1

[Simon Giesecke [:sg] [he/him]]

The generated domstubs.h header is also a forwarding header.