diff options
| author | Andreas Oppebøen <andreas.oppeboen@gmail.com> | 2022-11-25 00:03:57 +0100 |
|---|---|---|
| committer | Linus Groh <mail@linusgroh.de> | 2022-12-03 23:54:48 +0000 |
| commit | eb44a90e628be066dbfe685e19d3b64f977dcef1 (patch) | |
| tree | 80358269145b0e9dfb8cd4ccae5d8f4b7172fab3 | |
| parent | babfc13c846aba4f0800f700721e2955be438c02 (diff) | |
| download | serenity-eb44a90e628be066dbfe685e19d3b64f977dcef1.zip | |
Documentation: Recommend CLion code style settings over manual steps
Changing the naming conventions one-by-one was tedious and error-prone.
A settings file is likely to be more forward compatible than a
screenshot. The settings file was made by repeating the manual steps
provided in the documentation, and exporting the file in CLion.
| -rw-r--r-- | Documentation/CLionCodeStyleSettings.xml | 29 | ||||
| -rw-r--r-- | Documentation/CLionConfiguration.md | 9 | ||||
| -rw-r--r-- | Documentation/CLion_Naming_Convention.png | bin | 42321 -> 0 bytes |
3 files changed, 31 insertions, 7 deletions
diff --git a/Documentation/CLionCodeStyleSettings.xml b/Documentation/CLionCodeStyleSettings.xml new file mode 100644 index 0000000000..1f22e7173d --- /dev/null +++ b/Documentation/CLionCodeStyleSettings.xml @@ -0,0 +1,29 @@ +<code_scheme name="Project" version="173"> + <Objective-C> + <option name="TYPE_QUALIFIERS_PLACEMENT" value="AFTER" /> + </Objective-C> + <Objective-C-extensions> + <option name="TYPE_QUALIFIERS_PLACEMENT" value="AFTER" /> + <rules> + <rule entity="NAMESPACE" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" /> + <rule entity="MACRO" visibility="ANY" specifier="ANY" prefix="" style="SCREAMING_SNAKE_CASE" suffix="" /> + <rule entity="CLASS" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" /> + <rule entity="STRUCT" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" /> + <rule entity="ENUM" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" /> + <rule entity="ENUMERATOR" visibility="ANY" specifier="ANY" prefix="" style="PASCAL_CASE" suffix="" /> + <rule entity="TYPEDEF" visibility="ANY" specifier="ANY" prefix="" style="SNAKE_CASE" suffix="" /> + <rule entity="UNION" visibility="ANY" specifier="ANY" prefix="" style="SNAKE_CASE" suffix="" /> + <rule entity="CLASS_MEMBER_FUNCTION" visibility="ANY" specifier="ANY" prefix="" style="SNAKE_CASE" suffix="" /> + <rule entity="STRUCT_MEMBER_FUNCTION" visibility="ANY" specifier="ANY" prefix="" style="SNAKE_CASE" suffix="" /> + <rule entity="CLASS_MEMBER_FIELD" visibility="ANY" specifier="ANY" prefix="" style="SNAKE_CASE" suffix="" /> + <rule entity="STRUCT_MEMBER_FIELD" visibility="ANY" specifier="ANY" prefix="" style="SNAKE_CASE" suffix="" /> + <rule entity="GLOBAL_FUNCTION" visibility="ANY" specifier="ANY" prefix="" style="SNAKE_CASE" suffix="" /> + <rule entity="GLOBAL_VARIABLE" visibility="ANY" specifier="ANY" prefix="" style="SNAKE_CASE" suffix="" /> + <rule entity="PARAMETER" visibility="ANY" specifier="ANY" prefix="" style="SNAKE_CASE" suffix="" /> + <rule entity="LOCAL_VARIABLE" visibility="ANY" specifier="ANY" prefix="" style="SNAKE_CASE" suffix="" /> + </rules> + </Objective-C-extensions> + <clangFormatSettings> + <option name="ENABLED" value="true" /> + </clangFormatSettings> +</code_scheme> diff --git a/Documentation/CLionConfiguration.md b/Documentation/CLionConfiguration.md index 796dbdfd20..dd9563e948 100644 --- a/Documentation/CLionConfiguration.md +++ b/Documentation/CLionConfiguration.md @@ -48,13 +48,8 @@ A symptom of this not being configured correctly is CLion giving a warning for e ## Code Generation Settings -To make code generated by CLion (e.g. identifier names, const placement) match the SerenityOS coding style, change the -following options under `Settings -> Editor -> Code Style -> C/C++`: - -- On the `Code Generation` tab set `const/volatile qualifier placement` to `int const x = 0` -- On the `Naming Convention` tab, select the following: - -  +To make code generated by CLion match the SerenityOS coding style, import the `CLionCodeSyleSettings.xml` from this directory as code style scheme via +`Settings -> Editor -> Code Style -> C/C++ -> Scheme -> Cog icon -> Import Scheme...` ## Quick switching between Kernel and Userland targets diff --git a/Documentation/CLion_Naming_Convention.png b/Documentation/CLion_Naming_Convention.png Binary files differdeleted file mode 100644 index c7e437ed0e..0000000000 --- a/Documentation/CLion_Naming_Convention.png +++ /dev/null |
