Files
EWF/library/server/wsf/router/documentation/wsf_self_documented_handler.e
2013-09-24 15:23:15 +02:00

37 lines
1.2 KiB
Plaintext

note
description: "[
Interface defining a self documented handler
inherit from this class and define mapping_documentation to generate
auto self documentation on demand.
]"
date: "$Date$"
revision: "$Revision$"
deferred class
WSF_SELF_DOCUMENTED_HANDLER
feature -- Documentation
mapping_documentation (m: WSF_ROUTER_MAPPING; a_request_methods: detachable WSF_REQUEST_METHODS): WSF_ROUTER_MAPPING_DOCUMENTATION
-- Documentation associated with Current handler, in the context of the mapping `m' and methods `a_request_methods'.
--| `m' and `a_request_methods' are useful to produce specific documentation when the handler is used for multiple mapping.
require
m_attached: m /= Void
deferred
ensure
mapping_documentation_attached: Result /= Void
end
note
copyright: "2011-2013, Jocelyn Fiat, Javier Velilla, Olivier Ligot, Eiffel Software and others"
license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
source: "[
Eiffel Software
5949 Hollister Ave., Goleta, CA 93117 USA
Telephone 805-685-1006, Fax 805-685-6869
Website http://www.eiffel.com
Customer support http://support.eiffel.com
]"
end