Browse Source

example1: add some documentation to the methods

main
heck 2 years ago
parent
commit
94f9779fbd
  1. 47
      examples/example1/example1.yml2

47
examples/example1/example1.yml2

@ -45,8 +45,51 @@ pEpACIDLang {
// * claim
// * provide
method method1 {
param borrow struct1 param1;
method method1
brief="""
Send a ping message from the given from identity, fhdsajfghdjghkldhgsjhjhgjkdfslkghfhdsjklghkhkjfhsdkjlhgkdhskjh
which must be own,
to the given to identity.
"""
note="""
This automatically builds a message and sends it by calling
messageToSend on it; if messageToSend fails then its return
status is returned to the caller.
"""
{
param borrow struct1 param1
doc="session";
param mborrow struct1 param2
doc="""
This automatically builds a message and sends it by calling
messageToSend on it; if messageToSend fails then its return
status is returned to the caller. This automatically builds a message and sends it by calling
messageToSend on it; if messageToSend fails then its return
status is returned to the caller. This automatically builds a message and sends it by calling
messageToSend on it; if messageToSend fails then its return
status is returned to the caller.
""";
param claim struct1 param3;
param provide struct1 param4;
throws illegal_value
doc="""
This automatically builds a message and sends it by calling
messageToSend on it; if messageToSend fails then its return
status is returned to the caller.
""";
throws shrt_err
doc="""
This automatically builds a message and sends it by calling
messageToSend on it; if messageToSend fails then its return
status is returned to the caller.
""";
throws out_of_memory;
}
method method2 {

Loading…
Cancel
Save