Added missing descriptions

This commit is contained in:
jvelilla
2015-04-09 22:45:37 -03:00
parent 98621cb265
commit e41b0631d6
4 changed files with 13 additions and 16 deletions

View File

@@ -1,6 +1,5 @@
note note
description: "Summary description for {LOGGER}." description: "Object to log messages for a specific application. "
author: ""
date: "$Date$" date: "$Date$"
revision: "$Revision$" revision: "$Revision$"
@@ -27,11 +26,13 @@ create
feature {NONE} -- Initialization feature {NONE} -- Initialization
make make
-- Initialize a logger object.
do do
create log.make create log.make
end end
make_with_layout (app: APPLICATION_LAYOUT) make_with_layout (app: APPLICATION_LAYOUT)
-- Initialize a logger object with an application layout `app'.
do do
make make
apply_layout (app) apply_layout (app)
@@ -51,31 +52,37 @@ feature {NONE} -- Internal
feature -- Logging feature -- Logging
put_information (a_message: separate READABLE_STRING_8) put_information (a_message: separate READABLE_STRING_8)
-- Put message `a_message' to the log at information level.
do do
log.write_information (create {STRING}.make_from_separate (a_message)) log.write_information (create {STRING}.make_from_separate (a_message))
end end
put_error (a_message: separate READABLE_STRING_8) put_error (a_message: separate READABLE_STRING_8)
-- Put message `a_message' to the log at error level.
do do
log.write_error (create {STRING}.make_from_separate (a_message)) log.write_error (create {STRING}.make_from_separate (a_message))
end end
put_warning (a_message: separate READABLE_STRING_8) put_warning (a_message: separate READABLE_STRING_8)
-- Put message `a_message' to the log at warning level.
do do
log.write_warning (create {STRING}.make_from_separate (a_message)) log.write_warning (create {STRING}.make_from_separate (a_message))
end end
put_critical (a_message: separate READABLE_STRING_8) put_critical (a_message: separate READABLE_STRING_8)
-- Put message `a_message' to the log at critical level.
do do
log.write_critical (create {STRING}.make_from_separate (a_message)) log.write_critical (create {STRING}.make_from_separate (a_message))
end end
put_alert (a_message: separate READABLE_STRING_8) put_alert (a_message: separate READABLE_STRING_8)
-- Put message `a_message' to the log at alert level.
do do
log.write_alert (create {STRING}.make_from_separate (a_message)) log.write_alert (create {STRING}.make_from_separate (a_message))
end end
put_debug (a_message: separate READABLE_STRING_8) put_debug (a_message: separate READABLE_STRING_8)
-- Put message `a_message' to the log at debug level.
do do
log.write_debug (create {STRING}.make_from_separate (a_message)) log.write_debug (create {STRING}.make_from_separate (a_message))
end end

View File

@@ -22,7 +22,7 @@ feature -- Access
register_log_writer (a_log_writer: LOG_WRITER) register_log_writer (a_log_writer: LOG_WRITER)
-- -- Register the non-default log writer `a_log_writer'. -- Register the non-default log writer `a_log_writer'.
do do
logging.register_log_writer (a_log_writer) logging.register_log_writer (a_log_writer)
end end

View File

@@ -57,6 +57,7 @@ feature -- Access
id: INTEGER_64 assign set_id id: INTEGER_64 assign set_id
-- Unique id. -- Unique id.
--| Should we use NATURAL_64 instead?
content: READABLE_STRING_32 content: READABLE_STRING_32
-- Content of the node. -- Content of the node.
@@ -181,19 +182,6 @@ feature -- Element change
auther_set: author = u auther_set: author = u
end end
-- add_collaborator (a_user: CMS_USER)
-- -- Add collaborator `a_user' to the collaborators list.
-- local
-- lst: like collaborators
-- do
-- lst := collaborators
-- if lst = Void then
-- create {ARRAYED_SET [CMS_USER]} lst.make (1)
-- collaborators := lst
-- end
-- lst.force (a_user)
-- end
note note
copyright: "2011-2015, Javier Velilla, Jocelyn Fiat, Eiffel Software and others" copyright: "2011-2015, Javier Velilla, Jocelyn Fiat, Eiffel Software and others"
license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"

View File

@@ -21,6 +21,8 @@ feature -- Basic operations
local local
l_auth: HTTP_AUTHORIZATION l_auth: HTTP_AUTHORIZATION
do do
-- We can inherit from SHARED_LOGGER and write
-- write_debug_log ...
api.logger.put_debug (generator + ".execute ", Void) api.logger.put_debug (generator + ".execute ", Void)
create l_auth.make (req.http_authorization) create l_auth.make (req.http_authorization)
if attached req.raw_header_data as l_raw_data then if attached req.raw_header_data as l_raw_data then