CalvinBackup/iD
1
0
Fork 0
mirror of https://github.com/FoggedLens/iD.git synced 2026-02-12 16:52:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs updated

Browse Source
This commit is contained in:
Richard Fairhurst
2012-07-12 18:30:48 +01:00
parent 4ea76f1d2e
commit 2adf722945
2 changed files with 3 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/coding_standards.txt
View File

@@ -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.

7
docs/controllerstates.txt
View File

@@ -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