CONTRIBUTING.md

Coding style

Coding style inherits the Phobos style. There are little differences, such as no space after cast(...) operator. Common editor options are described in .editorconfig file in the root folder (of EditorConfig format).

Structure

Organize your code into meaningful blocks. Most of classes in the library use such layout:

class A
{
    @property
    {
        // properties
    }

    // public fields

    private
    {
        // private or protected fields
    }

    // constructors
    this();
    // destructor
    ~this();

    // methods
}

Write trivial getters in one line, for example:

@property
{
    /// Documentation comment
    long time() const { return _time; }
    /// ditto
    void time(long value)
    {
        _time = value;
        requestUniverseUpdate();
    }
}
private long _time;

Try to place functions below their first call. Humans prefer to read text top-to-bottom.

If you write a lot of code, split parts with the following line:

    //===============================================================
    // Stuff processing

Attributes

The member attributes and qualifiers on left-hand side should have such order:

abstract/final/override/static public/protected/package/private @property

I rarely use pure @nogc @system/@trusted/@safe in the library. I decided to not bother with them until they'll be properly implemented.

@property is needed only to split properties from other methods in documentation.

Naming

Signals and events almost always fit in such scheme:

• onXYZ - signal
• handleXYZ - corresponding class method (often protected)
• XYZHandler - delegate alias
• XYZSignal - signal alias

Simple enumerations are in singular, flag enums are almost always in plural.

Documentation

Use one general documentation comment and ditto in getter/setter pairs. Don't split them in two senseless "Get the ..." and "Set the ...".

Don't duplicate documentation from the base method to the overriden one. Documentation engine will do it by itself.

Start doc comments with an uppercase and simple comments with a lowercase letter.

Debugging constants

This section keeps all debug constants of the project. They add more logging in certain places of code.

You can enable them in two ways:

• into dub.sdl file in debugVersions property. This will force to rebuild the whole library, including dependencies.
• on top of the module you debug with debug = ...; statement. This will activate debug constant only in that module and won't rebuild everything.

More info

Common

resalloc

Platforms

sdl
x11
mouse
keys
layout
redraw
state
timers
tooltips

Widgets

editors
lists
menus
scrollbars
sliders
trees

Misc

FileFormats
FontResources
focus
styles