From fd0ee822a28d900997e0150351ccccc1df86bdf7 Mon Sep 17 00:00:00 2001 From: Paolo Cignoni cignoni Date: Thu, 29 Dec 2005 18:37:02 +0000 Subject: [PATCH] file added --- web/style.html | 148 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 web/style.html diff --git a/web/style.html b/web/style.html new file mode 100644 index 000000000..1685b81a6 --- /dev/null +++ b/web/style.html @@ -0,0 +1,148 @@ + + + + + + + + + + + + Meshlab + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

MeshLab Coding Guide

+ +
+ +

Naming rules

+ +

Our naming rules are Qt-style. It means:

+ + + + + +

Example:

+ +
   MeshLabClassExample
   {
   Q_OBJECT
   private:
      int privateVarName;
   
   public:
      bool publicVarName;
      void setValue(int &);
   }
+ +

Header Files

+ +

There are no strict rules on naming files, except for dialogs files.

+ +

Include files must begin with the standard legal disclamier/license +intestation and report in the first line of history the $LOG$ cvs +string. The following automatically generated history can be, from time +to time, compressed and shortened to save space.

+

No absolute include path are allowed.

+ + +

Each file has to include all the files that it requires. An +include file should rely on the files included by its own include files. 

+ +

In Class definitions place all the prototypes all together before the inline +or templated implementations.

+ + +

Editing rules

+ + +

Tabs are equivalent to two spaces.

+ + +

There are no strict rules placing white spaces, '{' or indenting.

+ +

Dialogs

+ +

A dialog tipically comes with three files: .ui, .h, .cpp. Each new .ui file must be placed in the "meshlab/ui" subfolder and its name must followed by "Dialog" suffix. Related .h and .cpp files must follow same rule but placed in the "meshlab" folder.

+ +

Example (Settings dialog):

+ +
  settingsDialog.ui  -> "meshlab/ui"
  settingsDialog.h   -> "meshlab/"
  settingsDialog.cpp -> "meshlab/"
+ +

Plugins

+ +

Is very simple to create a working plugin. Just read here!

+ + + +
+ + + +
+ + + +
+ + + +
+SourceForge.net Logo +

Development

+ +
+ +

Naming rules

+ +

Header Files

+ +

Editing rules

+ +

Dialogs

+ +

Plugin

+ + + +
+ + + + +