Added Missing Class and feature descriptions.

Removed author entry.
2015-04-06 12:24:47 -03:00
parent 7ac20bbcbc
commit 0b00bc4f68
21 changed files with 50 additions and 43 deletions
--- a/draft/library/server/wsf_js_widget/examples/demo/application_execution.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/application_execution.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {APPLICATION_EXECUTION}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/autocompletion/contact_autocompletion.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/autocompletion/contact_autocompletion.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {CONTACT_AUTOCOMPLETION}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/autocompletion/flag_autocompletion.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/autocompletion/flag_autocompletion.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {FLAG_AUTOCOMPLETION}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

@@ -33,22 +32,22 @@ feature -- Implementation
 			list := <<["AF", {STRING_32} "Afghanistan"], ["AX", {STRING_32} "<22>land Islands"], ["AL", {STRING_32} "Albania"],
 					["DZ", {STRING_32} "Algeria"], ["AS", {STRING_32} "American Samoa"],
 					["AD", {STRING_32} "Andorra"], ["AO", {STRING_32} "Angola"], ["AI", {STRING_32} "Anguilla"],
-					["AQ", {STRING_32} "Antarctica"], ["AG", {STRING_32} "Antigua and Barbuda"], 
+					["AQ", {STRING_32} "Antarctica"], ["AG", {STRING_32} "Antigua and Barbuda"],
 					["AR", {STRING_32} "Argentina"], ["AM", {STRING_32} "Armenia"], ["AW", {STRING_32} "Aruba"],
-					["AU", {STRING_32} "Australia"], ["AT", {STRING_32} "Austria"], ["AZ", {STRING_32} "Azerbaijan"], 
+					["AU", {STRING_32} "Australia"], ["AT", {STRING_32} "Austria"], ["AZ", {STRING_32} "Azerbaijan"],
 					["BS", {STRING_32} "Bahamas"], ["BH", {STRING_32} "Bahrain"], ["BD", {STRING_32} "Bangladesh"],
 					["BB", {STRING_32} "Barbados"], ["BY", {STRING_32} "Belarus"], ["BE", {STRING_32} "Belgium"],
 					["BZ", {STRING_32} "Belize"], ["BJ", {STRING_32} "Benin"], ["BM", {STRING_32} "Bermuda"],
 					["BT", {STRING_32} "Bhutan"], ["BO", {STRING_32} "Bolivia, Plurinational State of"],
 					["BQ", {STRING_32} "Bonaire, Sint Eustatius and Saba"], ["BA", {STRING_32} "Bosnia and Herzegovina"],
 					["BW", {STRING_32} "Botswana"], ["BV", {STRING_32} "Bouvet Island"],
-					["BR", {STRING_32} "Brazil"], ["IO", {STRING_32} "British Indian Ocean Territory"], 
-					["BN", {STRING_32} "Brunei Darussalam"], ["BG", {STRING_32} "Bulgaria"], 
+					["BR", {STRING_32} "Brazil"], ["IO", {STRING_32} "British Indian Ocean Territory"],
+					["BN", {STRING_32} "Brunei Darussalam"], ["BG", {STRING_32} "Bulgaria"],
 					["BF", {STRING_32} "Burkina Faso"], ["BI", {STRING_32} "Burundi"], ["KH", {STRING_32} "Cambodia"],
 					["CM", {STRING_32} "Cameroon"], ["CA", {STRING_32} "Canada"], ["CV", {STRING_32} "Cape Verde"],
-					["KY", {STRING_32} "Cayman Islands"], ["CF", {STRING_32} "Central African Republic"], 
+					["KY", {STRING_32} "Cayman Islands"], ["CF", {STRING_32} "Central African Republic"],
 					["TD", {STRING_32} "Chad"], ["CL", {STRING_32} "Chile"], ["CN", {STRING_32} "China"],
-					["CX", {STRING_32} "Christmas Island"], ["CC", {STRING_32} "Cocos (Keeling) Islands"], 
+					["CX", {STRING_32} "Christmas Island"], ["CC", {STRING_32} "Cocos (Keeling) Islands"],
 					["CO", {STRING_32} "Colombia"], ["KM", {STRING_32} "Comoros"], ["CG", {STRING_32} "Congo"],
 					["CD", {STRING_32} "Congo, the Democratic Republic of the"], ["CK", {STRING_32} "Cook Islands"],
 					["CR", {STRING_32} "Costa Rica"], ["CI", {STRING_32} "C<>te d'Ivoire"],
@@ -61,11 +60,11 @@ feature -- Implementation
 					["FO", {STRING_32} "Faroe Islands"], ["FJ", {STRING_32} "Fiji"], ["FI", {STRING_32} "Finland"],
 					["FR", {STRING_32} "France"], ["GF", {STRING_32} "French Guiana"],
 					["PF", {STRING_32} "French Polynesia"], ["TF", {STRING_32} "French Southern Territories"],
-					["GA", {STRING_32} "Gabon"], ["GM", {STRING_32} "Gambia"], ["GE", {STRING_32} "Georgia"], 
+					["GA", {STRING_32} "Gabon"], ["GM", {STRING_32} "Gambia"], ["GE", {STRING_32} "Georgia"],
 					["DE", {STRING_32} "Germany"], ["GH", {STRING_32} "Ghana"], ["GI", {STRING_32} "Gibraltar"],
 					["GR", {STRING_32} "Greece"], ["GL", {STRING_32} "Greenland"], ["GD", {STRING_32} "Grenada"],
-					["GP", {STRING_32} "Guadeloupe"], ["GU", {STRING_32} "Guam"], ["GT", {STRING_32} "Guatemala"], 
-					["GG", {STRING_32} "Guernsey"], ["GN", {STRING_32} "Guinea"], ["GW", {STRING_32} "Guinea-Bissau"], 
+					["GP", {STRING_32} "Guadeloupe"], ["GU", {STRING_32} "Guam"], ["GT", {STRING_32} "Guatemala"],
+					["GG", {STRING_32} "Guernsey"], ["GN", {STRING_32} "Guinea"], ["GW", {STRING_32} "Guinea-Bissau"],
 					["GY", {STRING_32} "Guyana"], ["HT", {STRING_32} "Haiti"], ["HM", {STRING_32} "Heard Island and McDonald Islands"],
 					["VA", {STRING_32} "Holy See (Vatican City State)"],
 					["HN", {STRING_32} "Honduras"], ["HK", {STRING_32} "Hong Kong"], ["HU", {STRING_32} "Hungary"],
@@ -92,41 +91,41 @@ feature -- Implementation
 					["NA", {STRING_32} "Namibia"], ["NR", {STRING_32} "Nauru"], ["NP", {STRING_32} "Nepal"],
 					["NL", {STRING_32} "Netherlands"], ["NC", {STRING_32} "New Caledonia"], ["NZ", {STRING_32} "New Zealand"],
 					["NI", {STRING_32} "Nicaragua"], ["NE", {STRING_32} "Niger"],
-					["NG", {STRING_32} "Nigeria"], ["NU", {STRING_32} "Niue"], ["NF", {STRING_32} "Norfolk Island"], 
+					["NG", {STRING_32} "Nigeria"], ["NU", {STRING_32} "Niue"], ["NF", {STRING_32} "Norfolk Island"],
 					["MP", {STRING_32} "Northern Mariana Islands"], ["NO", {STRING_32} "Norway"],
 					["OM", {STRING_32} "Oman"], ["PK", {STRING_32} "Pakistan"], ["PW", {STRING_32} "Palau"],
 					["PS", {STRING_32} "Palestinian Territory, Occupied"], ["PA", {STRING_32} "Panama"],
-					["PG", {STRING_32} "Papua New Guinea"], ["PY", {STRING_32} "Paraguay"], ["PE", {STRING_32} "Peru"], 
+					["PG", {STRING_32} "Papua New Guinea"], ["PY", {STRING_32} "Paraguay"], ["PE", {STRING_32} "Peru"],
 					["PH", {STRING_32} "Philippines"], ["PN", {STRING_32} "Pitcairn"],
 					["PL", {STRING_32} "Poland"], ["PT", {STRING_32} "Portugal"], ["PR", {STRING_32} "Puerto Rico"],
 					["QA", {STRING_32} "Qatar"], ["RE", {STRING_32} "R<>union"], ["RO", {STRING_32} "Romania"],
 					["RU", {STRING_32} "Russian Federation"], ["RW", {STRING_32} "Rwanda"], ["BL", {STRING_32} "Saint Barth<74>lemy"],
 					["SH", {STRING_32} "Saint Helena, Ascension and Tristan da Cunha"],
-					["KN", {STRING_32} "Saint Kitts and Nevis"], ["LC", {STRING_32} "Saint Lucia"], ["MF", {STRING_32} "Saint Martin (French part)"], 
+					["KN", {STRING_32} "Saint Kitts and Nevis"], ["LC", {STRING_32} "Saint Lucia"], ["MF", {STRING_32} "Saint Martin (French part)"],
 					["PM", {STRING_32} "Saint Pierre and Miquelon"],
-					["VC", {STRING_32} "Saint Vincent and the Grenadines"], ["WS", {STRING_32} "Samoa"], 
+					["VC", {STRING_32} "Saint Vincent and the Grenadines"], ["WS", {STRING_32} "Samoa"],
 					["SM", {STRING_32} "San Marino"], ["ST", {STRING_32} "Sao Tome and Principe"],
 					["SA", {STRING_32} "Saudi Arabia"], ["SN", {STRING_32} "Senegal"], ["RS", {STRING_32} "Serbia"],
 					["SC", {STRING_32} "Seychelles"], ["SL", {STRING_32} "Sierra Leone"],
-					["SG", {STRING_32} "Singapore"], ["SX", {STRING_32} "Sint Maarten (Dutch part)"], ["SK", {STRING_32} "Slovakia"], 
+					["SG", {STRING_32} "Singapore"], ["SX", {STRING_32} "Sint Maarten (Dutch part)"], ["SK", {STRING_32} "Slovakia"],
 					["SI", {STRING_32} "Slovenia"], ["SB", {STRING_32} "Solomon Islands"],
-					["SO", {STRING_32} "Somalia"], ["ZA", {STRING_32} "South Africa"], ["GS", {STRING_32} "South Georgia and the South Sandwich Islands"], 
-					["SS", {STRING_32} "South Sudan"], 
+					["SO", {STRING_32} "Somalia"], ["ZA", {STRING_32} "South Africa"], ["GS", {STRING_32} "South Georgia and the South Sandwich Islands"],
+					["SS", {STRING_32} "South Sudan"],
 					["ES", {STRING_32} "Spain"], ["LK", {STRING_32} "Sri Lanka"], ["SD", {STRING_32} "Sudan"], ["SR", {STRING_32} "Suriname"],
-					["SJ", {STRING_32} "Svalbard and Jan Mayen"], 
+					["SJ", {STRING_32} "Svalbard and Jan Mayen"],
 					["SZ", {STRING_32} "Swaziland"], ["SE", {STRING_32} "Sweden"], ["CH", {STRING_32} "Switzerland"],
-					["SY", {STRING_32} "Syrian Arab Republic"], 
+					["SY", {STRING_32} "Syrian Arab Republic"],
 					["TW", {STRING_32} "Taiwan, Province of China"], ["TJ", {STRING_32} "Tajikistan"],
 					["TZ", {STRING_32} "Tanzania, United Republic of"], ["TH", {STRING_32} "Thailand"],
-					["TL", {STRING_32} "Timor-Leste"], ["TG", {STRING_32} "Togo"], ["TK", {STRING_32} "Tokelau"], 
+					["TL", {STRING_32} "Timor-Leste"], ["TG", {STRING_32} "Togo"], ["TK", {STRING_32} "Tokelau"],
 					["TO", {STRING_32} "Tonga"], ["TT", {STRING_32} "Trinidad and Tobago"],
 					["TN", {STRING_32} "Tunisia"], ["TR", {STRING_32} "Turkey"], ["TM", {STRING_32} "Turkmenistan"],
 					["TC", {STRING_32} "Turks and Caicos Islands"], ["TV", {STRING_32} "Tuvalu"],
 					["UG", {STRING_32} "Uganda"], ["UA", {STRING_32} "Ukraine"], ["AE", {STRING_32} "United Arab Emirates"],
-					["GB", {STRING_32} "United Kingdom"], ["US", {STRING_32} "United States"], 
+					["GB", {STRING_32} "United Kingdom"], ["US", {STRING_32} "United States"],
 					["UM", {STRING_32} "United States Minor Outlying Islands"], ["UY", {STRING_32} "Uruguay"],
 					["UZ", {STRING_32} "Uzbekistan"], ["VU", {STRING_32} "Vanuatu"],
-					["VE", {STRING_32} "Venezuela, Bolivarian Republic of"], ["VN", {STRING_32} "Viet Nam"], 
+					["VE", {STRING_32} "Venezuela, Bolivarian Republic of"], ["VN", {STRING_32} "Viet Nam"],
 					["VG", {STRING_32} "Virgin Islands, British"],
 					["VI", {STRING_32} "Virgin Islands, U.S."], ["WF", {STRING_32} "Wallis and Futuna"],
 					["EH", {STRING_32} "Western Sahara"], ["YE", {STRING_32} "Yemen"],
--- a/draft/library/server/wsf_js_widget/examples/demo/autocompletion/google_autocompletion.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/autocompletion/google_autocompletion.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {GOOGLE_AUTOCOMPLETION}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/base_page.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/base_page.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {BASE_PAGE}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/codeview_page.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/codeview_page.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {CODEVIEW_PAGE}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {GOOGLE_NEWS}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_datasource.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_datasource.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {GOOGLE_NEWS_DATASOURCE}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_repeater.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/googlenews/google_news_repeater.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {GOOGLE_NEWS_REPEATER}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/grid_page.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/grid_page.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {GRID_PAGE}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/own_validator.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/own_validator.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {OWN_VALIDATOR}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/progress/increasing_progresssource.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/progress/increasing_progresssource.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {INCREASING_PROGRESSSOURCE}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/repeater_page.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/repeater_page.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {REPEATER_PAGE}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/sample_page.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/sample_page.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {SAMPLE_PAGE}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/slider_page.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/slider_page.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {SLIDER_PAGE}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/draft/library/server/wsf_js_widget/examples/demo/upload_page.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/upload_page.e
@@ -1,6 +1,5 @@
 note
 	description: "Summary description for {UPLOAD_PAGE}."
-	author: ""
 	date: "$Date$"
 	revision: "$Revision$"

--- a/library/server/ewsgi/connectors/standalone/src/httpd/concurrency/scoop/httpd_connection_handler.e
+++ b/library/server/ewsgi/connectors/standalone/src/httpd/concurrency/scoop/httpd_connection_handler.e
@@ -31,6 +31,8 @@ feature {NONE} -- Initialization
 		end

 	initialize_pool (p: like pool; n: INTEGER)
+			--  Initialize pool of separate connection handlers.
+			--| set the pool capacity to n.
 		do
 			p.set_count (n)
 		end
@@ -49,6 +51,7 @@ feature -- Access
 feature {HTTPD_SERVER_I} -- Execution

 	shutdown
+			-- <Precursor>
 		do
 			if not is_shutdown_requested then
 				is_shutdown_requested := True
@@ -57,11 +60,13 @@ feature {HTTPD_SERVER_I} -- Execution
 		end

 	pool_gracefull_stop (p: like pool)
+			-- Graceful stop pool of separate connection handlers.
 		do
 			p.gracefull_stop
 		end

 	accept_incoming_connection (a_listening_socket: HTTPD_STREAM_SOCKET)
+			-- <Precursor>
 		do
 			accept_connection_on_pool (pool, a_listening_socket) -- Wait on not pool.is_full or is_stop_requested
 		end
@@ -92,6 +97,7 @@ feature {HTTPD_SERVER_I} -- Execution
 		end

 	process_handler (hdl: separate HTTPD_REQUEST_HANDLER)
+			-- Process request handler `hdl' with exclusive access.
 		require
 			hdl.is_connected
 		do
@@ -99,6 +105,7 @@ feature {HTTPD_SERVER_I} -- Execution
 		end

 	separate_client_socket (hdl: separate HTTPD_REQUEST_HANDLER): separate HTTPD_STREAM_SOCKET
+			-- Separate client socket from a request handler `hdl'.
 		do
 			Result := hdl.client_socket
 		end
--- a/library/server/ewsgi/connectors/standalone/src/httpd/httpd_connection_handler_i.e
+++ b/library/server/ewsgi/connectors/standalone/src/httpd/httpd_connection_handler_i.e
@@ -79,6 +79,7 @@ feature {NONE} -- Implementation
 		end

 	separate_server_log (a_server: like server; a_message: separate READABLE_STRING_8)
+			-- Separete log from a server `a_server' with message `a_message'.
 		do
 			a_server.log (a_message)
 		end
--- a/library/server/ewsgi/connectors/standalone/src/httpd/httpd_request_handler_i.e
+++ b/library/server/ewsgi/connectors/standalone/src/httpd/httpd_request_handler_i.e
@@ -1,6 +1,5 @@
 note
-	description: "Summary description for {HTTPD_REQUEST_HANDLER_I}."
-	author: ""
+	description: "Represent a handler interface for components that process HTTP requests."
 	date: "$Date$"
 	revision: "$Revision$"

@@ -117,13 +116,17 @@ feature -- Status report
 feature -- Change

 	set_is_verbose (b: BOOLEAN)
+			-- Set `is_verbose' with `b'.
 		do
 			is_verbose := b
+		ensure
+			is_verbose_set: is_verbose = b
 		end

 feature -- Execution

 	safe_execute
+			-- Execute incoming request.
 		local
 			retried: BOOLEAN
 		do
@@ -194,6 +197,8 @@ feature -- Execution
 					dbglog (generator + ".execute_request  socket=" + l_socket.descriptor.out + " ENTER")
 				end
 				l_socket.set_timeout (5) -- 5 seconds!
+					--| TODO: add configuration options for socket timeout.
+					--| set by default 5 seconds.
 				l_ready_for_reading := l_socket.ready_for_reading
 				if l_ready_for_reading then
 					create l_remote_info
@@ -364,11 +369,15 @@ feature -- Output
 	logger: detachable HTTPD_LOGGER

 	set_logger (a_logger: like logger)
+			-- Set `logger' with `a_logger'.
 		do
 			logger := a_logger
+		ensure
+			logger_set: logger = a_logger
 		end

 	log (m: STRING)
+			-- Log message `m'.
 		do
 			if attached logger as l_logger then
 				l_logger.log (m)
--- a/library/server/ewsgi/connectors/standalone/test_standalone-safe.ecf
+++ b/library/server/ewsgi/connectors/standalone/test_standalone-safe.ecf
@@ -10,8 +10,12 @@
 		<library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/>
 		<library name="connector_standalone" location="standalone-safe.ecf" readonly="false"/>
 		<library name="ewsgi" location="..\..\ewsgi-safe.ecf" readonly="false"/>
-		<library name="httpd_EDIT" location="src\httpd\httpd-safe.ecf" readonly="false"/>
-		<library name="net_ssl_EDIT" location="$ISE_LIBRARY\unstable\library\network\socket\netssl\net_ssl-safe.ecf" readonly="false"/>
+		<library name="httpd_edit" location="src\httpd\httpd-safe.ecf" readonly="false">
+			<option debug="true">
+				<debug name="dbglog" enabled="true"/>
+			</option>
+		</library>
+		<library name="net_ssl_edit" location="$ISE_LIBRARY\unstable\library\network\socket\netssl\net_ssl-safe.ecf" readonly="false"/>
 		<library name="wsf" location="..\..\..\wsf\wsf-safe.ecf" readonly="false"/>
 		<cluster name="tests" location="tests\" recursive="true"/>
 	</target>
--- a/library/server/wsf/src/wsf_execution.e
+++ b/library/server/wsf/src/wsf_execution.e
@@ -1,6 +1,5 @@
 note
-	description: "Summary description for {WSF_EXECUTION}."
-	author: ""
+	description: "Object that represent a request execution with request and response. "
 	date: "$Date$"
 	revision: "$Revision$"

@@ -75,6 +74,7 @@ feature -- Status report
 feature -- Helpers

 	put_character (c: CHARACTER_8)
+			-- Send the character `c'.
 		require
 			message_writable: message_writable
 		do
@@ -82,6 +82,7 @@ feature -- Helpers
 		end

 	put_string (s: READABLE_STRING_8)
+			-- Send the string `s'.
 		require
 			message_writable: message_writable
 		do
@@ -89,6 +90,7 @@ feature -- Helpers
 		end

 	put_error (err: READABLE_STRING_8)
+			-- Report error described by `a_message'.
 		require
 			message_writable: message_writable
 		do