mcabber/CodingStyle.txt
author Mikael Berthe <mikael@lilotux.net>
Fri, 28 Sep 2018 17:56:42 +0200
changeset 2327 8ecc28068748
parent 1509 189ffdd944b4
child 2337 ffd0e57e9563
permissions -rw-r--r--
Silence another compiler warning (-Wimplicit-fallthrough)

This document describes the preferred coding style for the mcabber project.

If you intend to patch and contribute to mcabber, please try to use the
existing style, and read the following points.

- Do not use tabs, use space characters;
- Avoid trailing whitespace;
- Avoid lines longer than 80 characters;
- Indentation is 2 spaces (ok, maybe it isn't a good idea but it's the
  current style);
- Put a space after non-functions statements (e.g. if, while...)
- Put the opening brace last on the same line, and put the closing brace first
  except for functions, where the opening brace should be alone on a new line.

  Example:

    void example(void)
    {
      if (cond1) {
        do_a();
      } else if (cond2) {
        do_b();
      } else {
        do_c();
      }

      if (error)
        exit(0);
    }

 - Look at existing code for rules not mentioned here.

Mikael