From ffc671a1296cbe591549ed4ec0e4aea1095b25f8 Mon Sep 17 00:00:00 2001 From: "Olle E. Johansson" Date: Fri, 9 Jan 2015 21:32:15 +0100 Subject: [PATCH] exec Remove svn id, remove history, add doxygen --- modules/exec/exec.c | 29 ++++++++++++++++++++--------- modules/exec/exec.h | 10 ++++++---- modules/exec/exec_hf.c | 16 +++++++--------- modules/exec/exec_hf.h | 9 +++++++-- modules/exec/exec_mod.c | 13 +++++++------ modules/exec/kill.c | 13 +++++++------ modules/exec/kill.h | 9 +++++++-- 7 files changed, 61 insertions(+), 38 deletions(-) diff --git a/modules/exec/exec.c b/modules/exec/exec.c index 98a8f6f6402..4958535e62e 100644 --- a/modules/exec/exec.c +++ b/modules/exec/exec.c @@ -1,8 +1,4 @@ /* - * - * $Id$ - * - * * Copyright (C) 2001-2003 FhG Fokus * * This file is part of Kamailio, a free SIP server. @@ -21,13 +17,28 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - * History - * -------- - * 2003-02-28 scratchpad compatibility abandoned (jiri) - * 2003-01-28 scratchpad removed - * 2004-07-21 rewrite uri done via action() (bogdan) */ +/*! + * \file + * \brief Exec module:: Module interface + * \ingroup exec + * Module: \ref exec + */ + +/** + * @defgroup exec Execute external applications + * @brief Kamailio exec module + * + * The exec module allows external commands to be executed from a Kamailio script. + * The commands may be any valid shell commands--the command string is passed to the + * shell using “popen” command. Kamailio passes additional information about the request + * in environment variables. + * + */ + + + #include #include diff --git a/modules/exec/exec.h b/modules/exec/exec.h index 4d19732fb0f..a9a23c130cc 100644 --- a/modules/exec/exec.h +++ b/modules/exec/exec.h @@ -1,8 +1,4 @@ /* - * - * $Id$ - * - * * Copyright (C) 2001-2003 FhG Fokus * * This file is part of Kamailio, a free SIP server. @@ -21,6 +17,12 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +/*! + * \file + * \brief Exec module:: Module interface + * \ingroup exec + * Module: \ref exec + */ #ifndef _EXEC_H #define _EXEC_H diff --git a/modules/exec/exec_hf.c b/modules/exec/exec_hf.c index bed454198e3..2ada14a2ada 100644 --- a/modules/exec/exec_hf.c +++ b/modules/exec/exec_hf.c @@ -1,6 +1,4 @@ /* - * $Id$ - * * Copyright (C) 2001-2003 FhG Fokus * * This file is part of Kamailio, a free SIP server. @@ -19,15 +17,15 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - * history - * ------- - * 2003-02-28 scratchpad compatibility abandoned - * 2003-01-29 scratchpad removed - * 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri) - * 2003-03-19 all mallocs/frees replaced w/ pkg_malloc/pkg_free (andrei) */ -/* functions for creating environment variables out of a request's +/*! + * \file + * \brief Exec module:: Module interface + * \ingroup exec + * Module: \ref exec + * + * functions for creating environment variables out of a request's * header; known compact header field names are translated to * canonical form; multiple header field occurrences are merged * into a single variable diff --git a/modules/exec/exec_hf.h b/modules/exec/exec_hf.h index aa6587b4baa..4aa8eebed76 100644 --- a/modules/exec/exec_hf.h +++ b/modules/exec/exec_hf.h @@ -1,6 +1,4 @@ /* - * $Id$ - * * Copyright (C) 2001-2003 FhG Fokus * * This file is part of Kamailio, a free SIP server. @@ -20,6 +18,13 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +/*! + * \file + * \brief Exec module:: Header Field handling + * \ingroup exec + * Module: \ref exec + */ + #ifndef _EXEC_HF_H #define _EXEC_HF_H diff --git a/modules/exec/exec_mod.c b/modules/exec/exec_mod.c index b87245678e6..0e1aa107dba 100644 --- a/modules/exec/exec_mod.c +++ b/modules/exec/exec_mod.c @@ -1,8 +1,6 @@ /* * execution module * - * $Id$ - * * Copyright (C) 2001-2003 FhG Fokus * * This file is part of Kamailio, a free SIP server. @@ -21,10 +19,13 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - * History: - * ------- - * 2003-03-11: New module interface (janakj) - * 2003-03-16: flags export parameter added (janakj) + */ + +/*! + * \file + * \brief Exec module:: Module interface + * \ingroup exec + * Module: \ref exec */ diff --git a/modules/exec/kill.c b/modules/exec/kill.c index 643d8c7a2a4..9caa7279f06 100644 --- a/modules/exec/kill.c +++ b/modules/exec/kill.c @@ -1,6 +1,4 @@ /* - * $Id$ - * * Copyright (C) 2001-2003 FhG Fokus * * This file is part of Kamailio, a free SIP server. @@ -19,10 +17,13 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - * History: - * -------- - * 2003-03-11 changed to the new locking scheme: locking.h (andrei) - * + */ + +/*! + * \file + * \brief Exec module:: Kill + * \ingroup exec + * Module: \ref exec * * in this file, we implement the ability to send a kill signal to * a child after some time; its a quick ugly hack, for example kill diff --git a/modules/exec/kill.h b/modules/exec/kill.h index 8d9ba3646a0..132a1050c1f 100644 --- a/modules/exec/kill.h +++ b/modules/exec/kill.h @@ -1,6 +1,4 @@ /* - * $Id$ - * * Copyright (C) 2001-2003 FhG Fokus * * This file is part of Kamailio, a free SIP server. @@ -20,6 +18,13 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +/*! + * \file + * \brief Exec module:: Kill process + * \ingroup exec + * Module: \ref exec + */ + #ifndef _KILL_H #define _KILL_H