diff options
author | Marcello Stanisci <stanisci.m@gmail.com> | 2018-05-28 17:23:05 +0200 |
---|---|---|
committer | Marcello Stanisci <stanisci.m@gmail.com> | 2018-05-28 17:23:05 +0200 |
commit | 7a1146f147da5446b4b8488cc60d4368aadfe66a (patch) | |
tree | 491f2717ee32db73cca774baab3a0c2aa5f517de /src/exchange-lib/testing_api_trait_process.c | |
parent | 939c1dd6a57ec0cd93e255a933c5e55bca76f7f5 (diff) |
Commenting the remaining "lib" traits.
Diffstat (limited to 'src/exchange-lib/testing_api_trait_process.c')
-rw-r--r-- | src/exchange-lib/testing_api_trait_process.c | 56 |
1 files changed, 36 insertions, 20 deletions
diff --git a/src/exchange-lib/testing_api_trait_process.c b/src/exchange-lib/testing_api_trait_process.c index e3c1bdf4..297b5d39 100644 --- a/src/exchange-lib/testing_api_trait_process.c +++ b/src/exchange-lib/testing_api_trait_process.c @@ -2,21 +2,24 @@ This file is part of TALER Copyright (C) 2018 Taler Systems SA - TALER is free software; you can redistribute it and/or modify it under the - terms of the GNU General Public License as published by the Free Software - Foundation; either version 3, or (at your option) any later version. + TALER is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 3, + or (at your option) any later version. - TALER is distributed in the hope that it will be useful, but WITHOUT ANY - WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR - A PARTICULAR PURPOSE. See the GNU General Public License for more details. + TALER is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty + of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the GNU General Public License for more details. - You should have received a copy of the GNU General Public License along with - TALER; see the file COPYING. If not, see + You should have received a copy of the GNU General Public + License along with TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ + /** * @file exchange-lib/testing_api_trait_process.c - * @brief trait for a command that launches a process + * @brief trait offering process handles. * @author Christian Grothoff * @author Marcello Stanisci */ @@ -31,17 +34,21 @@ /** - * Obtain location where a command stores a pointer to a process + * Obtain location where a command stores a pointer to a process. + * + * @param cmd command to extract trait from. + * @param index which process to pick if @a cmd + * has multiple on offer. + * @param coin_priv[out] set to the address of the pointer to the + * process. * - * @param cmd command to extract trait from - * @param selector which process to pick if @a cmd has multiple on offer - * @param coin_priv[out] set to address of the pointer to the process - * @return #GNUNET_OK on success + * @return #GNUNET_OK on success. */ int -TALER_TESTING_get_trait_process (const struct TALER_TESTING_Command *cmd, - unsigned int index, - struct GNUNET_OS_Process ***processp) +TALER_TESTING_get_trait_process + (const struct TALER_TESTING_Command *cmd, + unsigned int index, + struct GNUNET_OS_Process ***processp) { return cmd->traits (cmd->cls, (void **) processp, @@ -50,9 +57,19 @@ TALER_TESTING_get_trait_process (const struct TALER_TESTING_Command *cmd, } +/** + * Offer location where a command stores a pointer to a process. + * + * @param index offered location index number, in case there are + * multiple on offer. + * @param processp process location to offer. + * + * @return the trait. + */ struct TALER_TESTING_Trait -TALER_TESTING_make_trait_process (unsigned int index, - struct GNUNET_OS_Process **processp) +TALER_TESTING_make_trait_process + (unsigned int index, + struct GNUNET_OS_Process **processp) { struct TALER_TESTING_Trait ret = { .index = index, @@ -63,5 +80,4 @@ TALER_TESTING_make_trait_process (unsigned int index, return ret; } - /* end of testing_api_trait_process.c */ |