Context Navigation

CodingStyle

v9	v10
103	103	This section has been copied from [http://doc.trolltech.com/qq/qq13-apis.html this] great article of the Qt Guys on APIs.
104	104
	105	In general but specially for public methods:
	106
105	107	* Do not abbreviate otherwise names will be more difficult to remember
106	108	* Parameter names are an important source of information
107	109	* Verbs have no prefix and don't use third person
108		* Use prefix set for setters and avoid prefix for getters,
	110	* Use prefix set for setters and avoid prefix for getters
	111
	112	As Perl syntax does not allow us to specify which methos are public, protected, or private we will stick to the following convention:
	113
	114	* Public methods will not need any prefix
	115	* Protected methods will start with '_', and its documentation will reflect that
	116	* Private methods will start with '_'
	117
	118	When overriding a method it is mandatory to refer to the documentation of the class which declared it.
	119
	120	{{{
	121	# Method: validateRow
	122	#
	123	# Override <EBox::Model::DataTable::validateRow> method
	124	#
	125	# Exceptions:
	126	#
	127	# <EBox::Exceptions::External> - throw if interface is not
	128	# external or the rule cannot be built
	129	#
	130	# <EBox::Exceptions::InvalidData> - throw if parameter has
	131	# invalid data
	132	#
	133	#
	134
	135	}}}
109	136
110	137	== Exporting symbols ==