Added comment to self documentation features

This commit is contained in:
Jocelyn Fiat
2012-12-20 10:09:26 +01:00
parent 619be9a8cd
commit 27d2308d6f
2 changed files with 5 additions and 0 deletions

View File

@@ -10,6 +10,8 @@ deferred class
feature -- Documentation feature -- Documentation
mapping_documentation (m: WSF_ROUTER_MAPPING; a_request_methods: detachable WSF_REQUEST_METHODS): WSF_ROUTER_MAPPING_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.
deferred deferred
end end

View File

@@ -13,6 +13,9 @@ inherit
feature -- Documentation feature -- Documentation
documentation (a_request_methods: detachable WSF_REQUEST_METHODS): WSF_ROUTER_MAPPING_DOCUMENTATION documentation (a_request_methods: detachable WSF_REQUEST_METHODS): WSF_ROUTER_MAPPING_DOCUMENTATION
-- Documentation associated with Current mapping, with methods `a_request_methods'.
--| If the associated handler is a WSF_SELF_DOCUMENTED_HANDLER , then the handler will also
--| Self described itself in the context of Current mapping and `a_request_methods'
do do
if attached {WSF_SELF_DOCUMENTED_HANDLER} handler as obj then if attached {WSF_SELF_DOCUMENTED_HANDLER} handler as obj then
Result := obj.mapping_documentation (Current, a_request_methods) Result := obj.mapping_documentation (Current, a_request_methods)