view mcabber/CodingStyle.txt @ 2245:bcb7bfa1cd09

Upgrade GPLv2 Since the GPLv2 has been included into mcabber, few changes have been made to the license itself. - Small improvements in centering some text - The FSF has changed mail address - The references to the GNU Library GPL license has been changed to GNU Lesser GPL license, since the former has been deprecated
author Fabio Alessandro Locati <fabiolocati@gmail.com>
date Thu, 04 Feb 2016 18:43:57 +0100
parents 189ffdd944b4
children ffd0e57e9563
line wrap: on
line source

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