Browse code

exec Remove svn id, remove history, add doxygen

Olle E. Johansson authored on 09/01/2015 20:32:15
Showing 7 changed files
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- *
3
- * $Id$
4
- *
5
- *
6 2
  * Copyright (C) 2001-2003 FhG Fokus
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -21,13 +17,28 @@
21 17
  * along with this program; if not, write to the Free Software 
22 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
23 19
  *
24
- * History
25
- * --------
26
- * 2003-02-28 scratchpad compatibility abandoned (jiri)
27
- * 2003-01-28 scratchpad removed
28
- * 2004-07-21 rewrite uri done via action() (bogdan)
29 20
  */
30 21
 
22
+/*!
23
+ * \file
24
+ * \brief Exec module:: Module interface
25
+ * \ingroup exec
26
+ * Module: \ref exec
27
+ */
28
+
29
+/**
30
+ * @defgroup exec Execute external applications
31
+ * @brief Kamailio exec module
32
+ *
33
+ * The exec module allows external commands to be executed from a Kamailio script.
34
+ * The commands may be any valid shell commands--the command string is passed to the 
35
+ * shell using “popen” command. Kamailio passes additional information about the request
36
+ * in environment variables.
37
+ *
38
+ */
39
+
40
+
41
+
31 42
 
32 43
 #include <stdio.h>
33 44
 #include <strings.h>
... ...
@@ -1,8 +1,4 @@
1 1
 /*
2
- *
3
- * $Id$
4
- *
5
- *
6 2
  * Copyright (C) 2001-2003 FhG Fokus
7 3
  *
8 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -21,6 +17,12 @@
21 17
  * along with this program; if not, write to the Free Software 
22 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
23 19
  */
20
+/*!
21
+ * \file
22
+ * \brief Exec module:: Module interface
23
+ * \ingroup exec 
24
+ * Module: \ref exec
25
+ */
24 26
 
25 27
 #ifndef _EXEC_H
26 28
 #define _EXEC_H
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2001-2003 FhG Fokus
5 3
  *
6 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -19,15 +17,15 @@
19 17
  * along with this program; if not, write to the Free Software 
20 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 19
  *
22
- * history
23
- * -------
24
- *  2003-02-28 scratchpad compatibility abandoned
25
- *  2003-01-29 scratchpad removed
26
- *  2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri)
27
- *  2003-03-19  all mallocs/frees replaced w/ pkg_malloc/pkg_free (andrei)
28 20
  */
29 21
 
30
-/* functions for creating environment variables out of a request's
22
+/*!
23
+ * \file
24
+ * \brief Exec module:: Module interface
25
+ * \ingroup exec 
26
+ * Module: \ref exec
27
+ *
28
+ * functions for creating environment variables out of a request's
31 29
  * header; known compact header field names are translated to
32 30
  * canonical form; multiple header field occurrences are merged
33 31
  * into a single variable
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2001-2003 FhG Fokus
5 3
  *
6 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -20,6 +18,13 @@
20 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 19
  */
22 20
 
21
+/*!
22
+ * \file
23
+ * \brief Exec module:: Header Field handling
24
+ * \ingroup exec 
25
+ * Module: \ref exec
26
+ */
27
+
23 28
 #ifndef _EXEC_HF_H
24 29
 #define _EXEC_HF_H
25 30
 
... ...
@@ -1,8 +1,6 @@
1 1
 /*
2 2
  * execution module
3 3
  *
4
- * $Id$
5
- *
6 4
  * Copyright (C) 2001-2003 FhG Fokus
7 5
  *
8 6
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -21,10 +19,13 @@
21 19
  * along with this program; if not, write to the Free Software 
22 20
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
23 21
  *
24
- * History:
25
- * -------
26
- * 2003-03-11: New module interface (janakj)
27
- * 2003-03-16: flags export parameter added (janakj)
22
+ */
23
+
24
+/*!
25
+ * \file
26
+ * \brief Exec module:: Module interface
27
+ * \ingroup exec 
28
+ * Module: \ref exec
28 29
  */
29 30
 
30 31
 
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2001-2003 FhG Fokus
5 3
  *
6 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -19,10 +17,13 @@
19 17
  * along with this program; if not, write to the Free Software 
20 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 19
  *
22
- * History:
23
- * --------
24
- *  2003-03-11  changed to the new locking scheme: locking.h (andrei)
25
- *
20
+ */
21
+
22
+/*!
23
+ * \file
24
+ * \brief Exec module:: Kill
25
+ * \ingroup exec 
26
+ * Module: \ref exec
26 27
  *
27 28
  * in this file, we implement the ability to send a kill signal to
28 29
  * a child after some time; its a quick ugly hack, for example kill
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2001-2003 FhG Fokus
5 3
  *
6 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -20,6 +18,13 @@
20 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 19
  */
22 20
 
21
+/*!
22
+ * \file
23
+ * \brief Exec module:: Kill process
24
+ * \ingroup exec 
25
+ * Module: \ref exec
26
+ */
27
+
23 28
 
24 29
 #ifndef _KILL_H
25 30
 #define _KILL_H