From: Abegail Jakop Date: Tue, 19 Jan 2016 22:43:56 +0000 (-0500) Subject: PR17741: expand try_assign macro description X-Git-Tag: release-3.0~188 X-Git-Url: https://sourceware.org/git/?a=commitdiff_plain;h=06a97c89f3ebf1269068d095692e549c524856be;p=systemtap.git PR17741: expand try_assign macro description --- diff --git a/tapset/try_assign.stpm b/tapset/try_assign.stpm index b18eb6f2a..834cd3c76 100644 --- a/tapset/try_assign.stpm +++ b/tapset/try_assign.stpm @@ -1,9 +1,18 @@ -// define a macro that executes a try catch statement. If there was no error, -// a provided variable is assigned to the evaluation of the try body, -// otherwise to the evaluation of the catch body. This assumes that the try and -// catch body are meant to return a value. If they do not, then do not use this -// macro. If either of the bodies do not return a value, then a compilation -// error occurs. +/* + * smacro try_assign - Assign the evaluation of the try-catch + * + * @assign_to: Where the evaluated value is stored in. + * @try_body: Expression making up the try body. + * @catch_body: Epxression making up the catch body. + * + * Description: Executes a try catch statement. If there was no error, + * a provided variable is assigned to the evaluation of the try body, + * otherwise to the evaluation of the catch body. This assumes that the try and + * catch body are meant to return a value. If they do not, then do not use this + * macro. If either of the bodies do not return a value, then a compilation + * error occurs. + * + */ @define try_assign(assign_to, try_body, catch_body) %( try {