Browse Source

exec Remove svn id, remove history, add doxygen

Olle E. Johansson 10 years ago
parent
commit
ffc671a129

+ 20 - 9
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 <stdio.h>
 #include <strings.h>

+ 6 - 4
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

+ 7 - 9
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

+ 7 - 2
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
 

+ 7 - 6
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
  */
 
 

+ 7 - 6
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

+ 7 - 2
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