Added Missing Class and feature descriptions.

Removed author entry.
2015-04-06 12:24:47 -03:00
parent a1a620a9c3
commit dc35925eb0
21 changed files with 29 additions and 22 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$"

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