From 2adf72294574c4a26aea8cf6be5bf4593227cc99 Mon Sep 17 00:00:00 2001 From: Richard Fairhurst Date: Thu, 12 Jul 2012 18:30:48 +0100 Subject: [PATCH] Docs updated --- docs/coding_standards.txt | 8 +++----- docs/controllerstates.txt | 7 ------- 2 files changed, 3 insertions(+), 12 deletions(-) delete mode 100755 docs/controllerstates.txt diff --git a/docs/coding_standards.txt b/docs/coding_standards.txt index e396d313d..0394e7206 100755 --- a/docs/coding_standards.txt +++ b/docs/coding_standards.txt @@ -22,18 +22,16 @@ Function names -------------- Anything that creates and calls an Action should be prefixed with do: doSetLatLon(lat,lon) + Anything that is called by an Action, to do the actual work, should be prefixed with an underscore: _setLatLon(lat,lon) -and commented as such. + +and commented as such. Underscores are also used to prefix private methods. File naming ----------- The filename should be the name of the base class. You can add subclasses within that file for clarity. Don't add extra classes that aren't subclasses, unless they're not referenced from elsewhere. -Class and variable names ------------------------- -You can prefix function arguments with an underscore to make it clear where they've come from. - Layout ------ * Hard tabs, indent of 4. diff --git a/docs/controllerstates.txt b/docs/controllerstates.txt deleted file mode 100755 index 84f35e863..000000000 --- a/docs/controllerstates.txt +++ /dev/null @@ -1,7 +0,0 @@ -Each ControllerState represents a UI state. - -They are grouped into folders: - -- 'edit' is all states within the 'Edit object' mode -- 'shape' is all states within the 'Add shape' mode -- 'point' is all states within the 'Add point' mode