SCLS Format "Mary"

Presentation

What is SCLS Format "Mary" ?

SCLS Format "Mary" is a very special part of the SCLS library. Indeed, it is not code, but a way to format C++ code. It is made for simplicity, documentation, practicity, versionning and beauty.

It is named after the american author Mary Higgins Clark, a very famous writer of suspense novel.

License

SCLS Format "Mary" is, of course, in the Public Domain. Indeed, we're not the kind of dicta... guys who put a format in any kind of privative license.
However, we would be grateful if you mention us if you use it.

Content

Base structuure

To be easily understandable, the file is cutted in each ways, with each ways has its special feature.

The first big part is the presentation of the file. It contains comments which present the file, with the file name, the project name, or others caracteristics.
This part is cutted in two tinier parts, the presentation in comments and the preprocessor directives of the start of the file (#include, #ifned...).

The presentation part contains the name of the project and the file, a description of the project and of the file, some user-defined stuff if needed and the licensing.