From f138911b65dfce85c551f9e2e4bbeb595d6c6755 Mon Sep 17 00:00:00 2001
From: un1versal
Date: Wed, 2 Mar 2016 12:15:44 +0000
Subject: documentation: formatting/indentation + minor syntax fixes

+ Dont use double quotes to emphasise words in normal circumstances.
+ improve indenting + consistency (good for readability when editing source)
+ also replace single quotes
---
 src/modules/objects/KvsObject_lineEdit.cpp | 51 +++++++++++++++---------------
 1 file changed, 25 insertions(+), 26 deletions(-)

(limited to 'src/modules/objects/KvsObject_lineEdit.cpp')

diff --git a/src/modules/objects/KvsObject_lineEdit.cpp b/src/modules/objects/KvsObject_lineEdit.cpp
index 8a194cef7..f6ccd00c3 100644
--- a/src/modules/objects/KvsObject_lineEdit.cpp
+++ b/src/modules/objects/KvsObject_lineEdit.cpp
@@ -44,7 +44,6 @@ static const int mode_cod[] =  {
 
 #define mode_num	(sizeof(mode_tbl) / sizeof(mode_tbl[0]))
 
-
 /*
 	@doc:	lineedit
 	@keyterms:
@@ -72,9 +71,11 @@ static const int mode_cod[] =  {
 		See also [classfnc]$text[/classfnc]().
 		!fn: $setEchoMode(<echo_mode:string>)
 		Sets the line edit's echo mode. Possible value are:[br]
-		-Normal: display chars as they entered[br]
-		-Noecho: do not display anything[br]
-		-Password: display asterisks instead of the characters actually entered[br]
+		[pre]
+			-Normal: display chars as they entered[br]
+			-Noecho: do not display anything[br]
+			-Password: display asterisks instead of the characters actually entered[br]
+		[/pre]
 		See also [classfnc]$echoMode[/classfnc]().
 		!fn: <string> $echoMode()
 		Return the line edit's echo mode.
@@ -134,29 +135,29 @@ static const int mode_cod[] =  {
 		Sets the validation input mask to inputMask.[br]
 		[b]Example:[/b][br]
 		[example]
-		%ledit_example->$setInputMask( "+99 99 99 99 99;_" );[br]
-		%ledit_example->$setInputMask( "000.000.000.000;_" );[br]
-		%ledit_example->IP Number Mask.[br]
-		%ledit_example->setInputMask( ">AAAAA-AAAAA-AAAAA-AAAAA-AAAAA;#" );
+			%ledit_example->$setInputMask( "+99 99 99 99 99;_" );[br]
+			%ledit_example->$setInputMask( "000.000.000.000;_" );[br]
+			%ledit_example->IP Number Mask.[br]
+			%ledit_example->setInputMask( ">AAAAA-AAAAA-AAAAA-AAAAA-AAAAA;#" );
 		[/example]
 		The mask format understands these mask characters:[br]
 		[example]
-		[b][comment]Character	Meaning[/comment][/b][br]
-		A	-	ASCII alphabetic character required. A-Z, a-z.[br]
-		a	-	ASCII alphabetic character permitted but not required.[br]
-		N	-	ASCII alphanumeric character required. A-Z, a-z, 0-9.[br]
-		n	-	ASCII alphanumeric character permitted but not required.[br]
-		X	-	Any character required.[br]
-		x	-	Any character permitted but not required.[br]
-		9	-	ASCII digit required. 0-9.[br]
-		0	-	ASCII digit permitted but not required.[br]
-		D	-	ASCII digit required. 1-9.[br]
-		d	-	ASCII digit permitted but not required.[br]
-		#	-	ASCII digit or plus/minus sign permitted but not required.[br]
-		>	-	All following alphabetic characters are uppercased.[br]
-		<	-	All following alphabetic characters are lowercased.[br]
-		!	-	Switch off case conversion.[br]
-		\	-	Use \ to escape the special characters listed above to use them as separators.
+			[b][comment]Character	Meaning[/comment][/b][br]
+			A	-	ASCII alphabetic character required. A-Z, a-z.[br]
+			a	-	ASCII alphabetic character permitted but not required.[br]
+			N	-	ASCII alphanumeric character required. A-Z, a-z, 0-9.[br]
+			n	-	ASCII alphanumeric character permitted but not required.[br]
+			X	-	Any character required.[br]
+			x	-	Any character permitted but not required.[br]
+			9	-	ASCII digit required. 0-9.[br]
+			0	-	ASCII digit permitted but not required.[br]
+			D	-	ASCII digit required. 1-9.[br]
+			d	-	ASCII digit permitted but not required.[br]
+			#	-	ASCII digit or plus/minus sign permitted but not required.[br]
+			>	-	All following alphabetic characters are uppercased.[br]
+			<	-	All following alphabetic characters are lowercased.[br]
+			!	-	Switch off case conversion.[br]
+			\	-	Use \ to escape the special characters listed above to use them as separators.
 		[/example]
 		The mask consists of a string of mask characters and separators, optionally[br]
 		followed by a semi-colon and the character used for blanks: the blank characters[br]
@@ -188,8 +189,6 @@ static const int mode_cod[] =  {
 		This signal is emitted by the default implementation of [classfnc]$textChangedEvent[/classfnc]().
 */
 
-
-
 KVSO_BEGIN_REGISTERCLASS(KvsObject_lineEdit,"lineedit","widget")
 
 	KVSO_REGISTER_HANDLER_BY_NAME(KvsObject_lineEdit,text)
-- 
cgit v1.3.1-10-gc9f91