RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2025-01-31 12:41:49 +01:00
Code Issues Projects Releases Wiki Activity

[doc] Describe the header guard style

Browse Source 
clang-tidy's llvm-header-guard rule references the LLVM style - where it's
missing.

Differential Revision: https://reviews.llvm.org/D84989
This commit is contained in:
Mircea Trofin 2020-07-30 16:08:06 -07:00
parent ed417d552d
commit 629123ee54
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/CodingStandards.rst
View File

@ -174,6 +174,16 @@ used as an abstract. Any additional information should be separated by a blank
line. If an algorithm is based on a paper or is described in another source,
provide a reference.
Header Guard
""""""""""""
The header file's guard should be the all-caps path that a user of this header
would #include, using '_' instead of path separator and extension marker.
For example, the header file
``llvm/include/llvm/Analysis/Utils/Local.h`` would be ``#include``-ed as
``#include "llvm/Analysis/Utils/Local.h"``, so its guard is
``LLVM_ANALYSIS_UTILS_LOCAL_H``.
Class overviews
"""""""""""""""