summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorTobias Christiansen <tobyase@serenityos.org>2021-09-19 21:51:44 +0200
committerAndreas Kling <kling@serenityos.org>2021-09-19 22:57:58 +0200
commitf6ffa09437c1d2df857796f7c750bf61316ced2d (patch)
tree7a2110b94101aa6c2f74c6112bd89d41cb066053 /Documentation
parent0cedb7a7c47b8232cecb31c55b0ca556bcc13cec (diff)
downloadserenity-f6ffa09437c1d2df857796f7c750bf61316ced2d.zip
Meta: Add section to CLion Configuration Docs about including headers
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/CLionConfiguration.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/CLionConfiguration.md b/Documentation/CLionConfiguration.md
index 2fb953b93b..8e723aca1a 100644
--- a/Documentation/CLionConfiguration.md
+++ b/Documentation/CLionConfiguration.md
@@ -39,6 +39,13 @@ want exclude Toolchain files as well, follow the same procedure with the followi
- `Toolchain/Tarballs`
- `Toolchain/Build`
+## Include headers and source files for code insight
+
+To get proper code insight mark the folders `AK`, `Kernel` and `Userland` by right-clicking on them and selecting `Mark Directory as | Project Sources and Headers`.
+
+A symptom of this not being configured correctly is CLion giving a warning for every single file:
+> The file does not belong to any project target, code insight features might not work properly.
+
## Code Generation Settings
To make code generated by CLion (e.g. identifier names, const placement) match the SerenityOS coding style, change the