Commit af12c235 authored by fw4splbot's avatar fw4splbot
Browse files

merge(dev): release 16.0.0

parents 66b0b5bc ab6866d6
......@@ -34,16 +34,11 @@ Source and files
.. rule :: Protection against multiple inclusions
You must protect your files against multiple inclusions. To this end, use the standard directives of the precompiler ``#ifndef`` and ``#define`` (since ``#pragma`` once is only supported by Microsoft compilers).
You must protect your files against multiple inclusions. To this end, use ``#pragma once`` .
Use the name of the file and the namespace hierarchy inside the define name in order to prevent any conflict with a file which has the same name but located in a different namespace. Namespaces and file name must be separated by a single underscore ``_``. The define name must be prefixed and suffixed by two underscores ``__``. Last, a comment must be placed after ``#endif`` to quote the define.
.. code-block :: cpp
#ifndef __NAMESPACEA_NAMESPACEB_SAMPLE_HPP__ // Preamble protecting against
#define __NAMESPACEA_NAMESPACEB_SAMPLE_HPP__ // multiple inclusions.
#endif // __NAMESPACEA_NAMESPACEB_SAMPLE_HPP__
#pragma once
.. recommendation :: Independent headers
......@@ -189,7 +184,7 @@ Naming conventions
.. rule :: Constant
Constant variables must be written in snake_case but in capitals, and follow the previous rule.
Static constant variables must be written in snake_case but in capitals, and follow the previous rule.
.. code-block :: cpp
......@@ -198,11 +193,6 @@ Naming conventions
static const int s_AAA_BBB_CCC_VALUE = 1;
};
void fooFunction()
{
const int AAA_BBB_VAR = 1;
...
}
.. rule :: Type
......@@ -498,7 +488,16 @@ Miscellaneous
.. rule :: Keyword const
Use this keyword as much as possible for variables, parameters and functions.
Use this keyword as much as possible for variables, parameters and functions. When used for a variable or a parameter, it should be placed on the left of the qualified id, e.g. :
.. code-block :: cpp
const double factor = 1.0;
const auto* pFactor = &factor;
std::vector< const Object* > objectsList;
void func(const Object& param);
.. recommendation :: Keyword auto
......@@ -535,4 +534,4 @@ Miscellaneous
16 int16_t uint16_t
32 int32_t uint32_t
64 int64_t uint64_t
====== ========= ==========
\ No newline at end of file
====== ========= ==========
......@@ -37,7 +37,6 @@ This file describes the project information and requirements :
servicesReg
gui
guiQt
io # contains the interface for reader and writer.
ioVTK # contains the reader and writer for VTK files (image and mesh).
visuVTK # loads VTK rendering library (fwRenderVTK).
visuVTKQt # containsthe vtk Renderer window interactor manager using Qt.
......
......@@ -38,7 +38,6 @@ This file describes the project information and requirements :
servicesReg
gui
guiQt
io
ioVTK
uiIO # contains services to show dialogs for reader/writer selection
visuVTKQt
......
......@@ -39,7 +39,6 @@ This file describes the project information and requirements :
servicesReg
gui
guiQt
io
ioVTK
uiIO
visuVTKQt
......
......@@ -38,7 +38,6 @@ This file describes the project information and requirements :
servicesReg
gui
guiQt
io
ioVTK
visuVTKQt
uiIO
......
......@@ -38,7 +38,6 @@ This file describes the project information and requirements :
servicesReg
gui
guiQt
io
ioVTK
uiIO
visuVTKQt
......
......@@ -47,7 +47,6 @@ This file describes the project information and requirements :
servicesReg
gui
guiQt
io
ioData # contains reader/writer for mesh (.trian) or matrix (.trf)
ioVTK
uiIO
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment