> module embeds its lookup tables in its own documentation
Depending on who your target audience is... you might consider explicitly
stating what kind of lookup tables? Message->Method dispatch?
in relation to: "=item public echo(Data)" you state:
> The "public" states that echo() will handle "echo" messages
How does this connect the echo method with the echo message?
I've now been staring at the "package Echoer" example trying to figure out
the embedded documentation for several minutes. But it doesn't seem explicit
or consistent enough.
"public echo(Data)"
means that the echo _method_ handles "Data" messages? but...
"Emits: echoer(Data)"
means echoer _messages_ of type "Data" are sent?
Seems like you're conflating the syntax of messages and methods... And maybe
I'm just showing my ignorance, but I'm confused as to whether you're talking
about "echo" messages, or "data" messages. And what it means for an "echo"
message to be of type "data".
(And now for more paint on the bikeshed)...
I'd like a syntax more like:
dispatch_rule:
'method' method_identifier signature(?) visibility(?) emission(?)
signature:
'(' typed_message(s? /\,/) ')'
typed_messages:
type_identifier message_identifier
visibility:
'is' ('public' | 'private')
emission:
':' typed_messages(s? /\,/)
Examples:
method echo
method echo()
method echo(DATA echo)
method echo(DATA echo) is public
method echo(DATA echo) is public : DATA echoer
method echo(DATA echo) is public : DATA echoer, DATA log
--
Garrett Goebel
IS Development Specialist
ScriptPro Direct: 913.403.5261
5828 Reeds Road Main: 913.384.1008
Mission, KS 66202 Fax: 913.384.2180
www.scriptpro.com [EMAIL PROTECTED]
