more doxygenification (issue #5513)

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@6852 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2025-09-04 11:58:52 +00:00 · 2005-10-26 13:03:17 +00:00
parent c7db73070a
commit 6324072247
62 changed files with 880 additions and 810 deletions
--- a/codecs/adpcm_slin_ex.h
+++ b/codecs/adpcm_slin_ex.h
@@ -1,11 +1,11 @@
-/*
+/*! \file
 * adpcm_slin_ex.h --
 *
- *	4-bit ADPCM data, 20 milliseconds worth at 8 kHz.
+ * \brief	4-bit ADPCM data, 20 milliseconds worth at 8 kHz.
 *
 * Source: g723.example
 *
- * Copyright (C) 2001, Linux Support Services, Inc.
+ * Copyright (C) 2001-2005, Digium, Inc.
 *
 * Distributed under the terms of the GNU General Public License
 *
--- a/codecs/codec_a_mu.c
+++ b/codecs/codec_a_mu.c
@@ -16,9 +16,9 @@
 * at the top of the source tree.
 */

-/* 
+/*! \file
 *
- * codec_a_mu.c - translate between alaw and ulaw directly
+ * \brief codec_a_mu.c - translate between alaw and ulaw directly
 *
 */

--- a/codecs/codec_adpcm.c
+++ b/codecs/codec_adpcm.c
@@ -20,9 +20,9 @@
 * at the top of the source tree.
 */

-/* 
+/*! \file
 *
- * codec_adpcm.c - translate between signed linear and Dialogic ADPCM
+ * \brief codec_adpcm.c - translate between signed linear and Dialogic ADPCM
 * 
 */

--- a/codecs/codec_alaw.c
+++ b/codecs/codec_alaw.c
@@ -16,9 +16,9 @@
 * at the top of the source tree.
 */

-/*
+/*! \file
 *
- * codec_alaw.c - translate between signed linear and alaw
+ * \brief codec_alaw.c - translate between signed linear and alaw
 * 
 */

@@ -56,22 +56,20 @@ static int useplc = 0;
 #include "slin_ulaw_ex.h"
 #include "ulaw_slin_ex.h"

-/*
- * Private workspace for translating signed linear signals to alaw.
+/*!
+ * \brief Private workspace for translating signed linear signals to alaw.
 */
-
 struct alaw_encoder_pvt
 {
  struct ast_frame f;
-  char offset[AST_FRIENDLY_OFFSET];   /* Space to build offset */
-  unsigned char outbuf[BUFFER_SIZE];  /* Encoded alaw, two nibbles to a word */
+  char offset[AST_FRIENDLY_OFFSET];   /*!< Space to build offset */
+  unsigned char outbuf[BUFFER_SIZE];  /*!< Encoded alaw, two nibbles to a word */
  int tail;
 };

-/*
- * Private workspace for translating alaw signals to signed linear.
+/*!
+ * \brief Private workspace for translating alaw signals to signed linear.
 */
-
 struct alaw_decoder_pvt
 {
  struct ast_frame f;
@@ -81,8 +79,8 @@ struct alaw_decoder_pvt
  plc_state_t plc;
 };

-/*
- * alawToLin_New
+/*!
+ * \brief alawToLin_New
 *  Create a new instance of alaw_decoder_pvt.
 *
 * Results:
@@ -92,8 +90,7 @@ struct alaw_decoder_pvt
 *  None.
 */

-static struct ast_translator_pvt *
-alawtolin_new (void)
+static struct ast_translator_pvt * alawtolin_new (void)
 {
  struct alaw_decoder_pvt *tmp;
  tmp = malloc (sizeof (struct alaw_decoder_pvt));
@@ -108,8 +105,8 @@ alawtolin_new (void)
  return (struct ast_translator_pvt *) tmp;
 }

-/*
- * LinToalaw_New
+/*!
+ * \brief LinToalaw_New
 *  Create a new instance of alaw_encoder_pvt.
 *
 * Results:
@@ -119,8 +116,7 @@ alawtolin_new (void)
 *  None.
 */

-static struct ast_translator_pvt *
-lintoalaw_new (void)
+static struct ast_translator_pvt * lintoalaw_new (void)
 {
  struct alaw_encoder_pvt *tmp;
  tmp = malloc (sizeof (struct alaw_encoder_pvt));
@@ -134,8 +130,8 @@ lintoalaw_new (void)
  return (struct ast_translator_pvt *) tmp;
 }

-/*
- * alawToLin_FrameIn
+/*!
+ * \brief alawToLin_FrameIn
 *  Fill an input buffer with packed 4-bit alaw values if there is room
 *  left.
 *
@@ -181,8 +177,8 @@ alawtolin_framein (struct ast_translator_pvt *pvt, struct ast_frame *f)
  return 0;
 }

-/*
- * alawToLin_FrameOut
+/*!
+ * \brief alawToLin_FrameOut
 *  Convert 4-bit alaw encoded signals to 16-bit signed linear.
 *
 * Results:
@@ -193,8 +189,7 @@ alawtolin_framein (struct ast_translator_pvt *pvt, struct ast_frame *f)
 *  None.
 */

-static struct ast_frame *
-alawtolin_frameout (struct ast_translator_pvt *pvt)
+static struct ast_frame * alawtolin_frameout (struct ast_translator_pvt *pvt)
 {
  struct alaw_decoder_pvt *tmp = (struct alaw_decoder_pvt *) pvt;

@@ -213,8 +208,8 @@ alawtolin_frameout (struct ast_translator_pvt *pvt)
  return &tmp->f;
 }

-/*
- * LinToalaw_FrameIn
+/*!
+ * \brief LinToalaw_FrameIn
 *  Fill an input buffer with 16-bit signed linear PCM values.
 *
 * Results:
@@ -224,8 +219,7 @@ alawtolin_frameout (struct ast_translator_pvt *pvt)
 *  tmp->tail is number of signal values in the input buffer.
 */

-static int
-lintoalaw_framein (struct ast_translator_pvt *pvt, struct ast_frame *f)
+static int lintoalaw_framein (struct ast_translator_pvt *pvt, struct ast_frame *f)
 {
  struct alaw_encoder_pvt *tmp = (struct alaw_encoder_pvt *) pvt;
  int x;
@@ -242,8 +236,8 @@ lintoalaw_framein (struct ast_translator_pvt *pvt, struct ast_frame *f)
  return 0;
 }

-/*
- * LinToalaw_FrameOut
+/*!
+ * \brief LinToalaw_FrameOut
 *  Convert a buffer of raw 16-bit signed linear PCM to a buffer
 *  of 4-bit alaw packed two to a byte (Big Endian).
 *
@@ -254,8 +248,7 @@ lintoalaw_framein (struct ast_translator_pvt *pvt, struct ast_frame *f)
 *  Leftover inbuf data gets packed, tail gets updated.
 */

-static struct ast_frame *
-lintoalaw_frameout (struct ast_translator_pvt *pvt)
+static struct ast_frame * lintoalaw_frameout (struct ast_translator_pvt *pvt)
 {
  struct alaw_encoder_pvt *tmp = (struct alaw_encoder_pvt *) pvt;
  
@@ -274,12 +267,11 @@ lintoalaw_frameout (struct ast_translator_pvt *pvt)
 }


-/*
- * alawToLin_Sample
+/*!
+ * \brief alawToLin_Sample
 */

-static struct ast_frame *
-alawtolin_sample (void)
+static struct ast_frame * alawtolin_sample (void)
 {
  static struct ast_frame f;
  f.frametype = AST_FRAME_VOICE;
@@ -293,12 +285,11 @@ alawtolin_sample (void)
  return &f;
 }

-/*
- * LinToalaw_Sample
+/*!
+ * \brief LinToalaw_Sample
 */

-static struct ast_frame *
-lintoalaw_sample (void)
+static struct ast_frame * lintoalaw_sample (void)
 {
  static struct ast_frame f;
  f.frametype = AST_FRAME_VOICE;
@@ -313,8 +304,8 @@ lintoalaw_sample (void)
  return &f;
 }

-/*
- * alaw_Destroy
+/*!
+ * \brief alaw_Destroy
 *  Destroys a private workspace.
 *
 * Results:
@@ -324,16 +315,15 @@ lintoalaw_sample (void)
 *  None.
 */

-static void
-alaw_destroy (struct ast_translator_pvt *pvt)
+static void alaw_destroy (struct ast_translator_pvt *pvt)
 {
  free (pvt);
  localusecnt--;
  ast_update_use_count ();
 }

-/*
- * The complete translator for alawToLin.
+/*!
+ * \brief The complete translator for alawToLin.
 */

 static struct ast_translator alawtolin = {
@@ -348,8 +338,8 @@ static struct ast_translator alawtolin = {
  alawtolin_sample
 };

-/*
- * The complete translator for LinToalaw.
+/*!
+ * \brief The complete translator for LinToalaw.
 */

 static struct ast_translator lintoalaw = {
@@ -364,8 +354,7 @@ static struct ast_translator lintoalaw = {
  lintoalaw_sample
 };

-static void 
-parse_config(void)
+static void parse_config(void)
 {
  struct ast_config *cfg;
  struct ast_variable *var;
@@ -385,15 +374,13 @@ parse_config(void)
  }
 }

-int
-reload(void)
+int reload(void)
 {
  parse_config();
  return 0;
 }

-int
-unload_module (void)
+int unload_module (void)
 {
  int res;
  ast_mutex_lock (&localuser_lock);
@@ -406,8 +393,7 @@ unload_module (void)
  return res;
 }

-int
-load_module (void)
+int load_module (void)
 {
  int res;
  parse_config();
@@ -423,22 +409,19 @@ load_module (void)
 * Return a description of this module.
 */

-char *
-description (void)
+char * description (void)
 {
  return tdesc;
 }

-int
-usecount (void)
+int usecount (void)
 {
  int res;
  STANDARD_USECOUNT (res);
  return res;
 }

-char *
-key ()
+char * key ()
 {
  return ASTERISK_GPL_KEY;
 }
--- a/codecs/codec_g723_1.c
+++ b/codecs/codec_g723_1.c
@@ -20,9 +20,9 @@
 * at the top of the source tree.
 */

-/*
+/*! \file
 *
- * Translate between signed linear and G.723.1
+ * \brief Translate between signed linear and G.723.1
 *
 */

--- a/codecs/codec_g726.c
+++ b/codecs/codec_g726.c
@@ -20,9 +20,9 @@
 */


-/*
+/*! \file
 *
- * codec_g726.c - translate between signed linear and ITU G.726-32kbps
+ * \brief codec_g726.c - translate between signed linear and ITU G.726-32kbps
 *
 */

--- a/codecs/codec_gsm.c
+++ b/codecs/codec_gsm.c
@@ -19,9 +19,9 @@
 * at the top of the source tree.
 */

-/*
+/*! \file
 *
- * Translate between signed linear and Global System for Mobile Communications (GSM)
+ * \brief Translate between signed linear and Global System for Mobile Communications (GSM)
 *
 */

--- a/codecs/codec_ilbc.c
+++ b/codecs/codec_ilbc.c
@@ -18,9 +18,9 @@
 * at the top of the source tree.
 */

-/*
+/*! \file
 *
- * Translate between signed linear and Internet Low Bitrate Codec
+ * \brief Translate between signed linear and Internet Low Bitrate Codec
 * 
 */

--- a/codecs/codec_lpc10.c
+++ b/codecs/codec_lpc10.c
@@ -20,9 +20,9 @@
 * at the top of the source tree.
 */

-/*
+/*! \file
 *
- * Translate between signed linear and LPC10 (Linear Predictor Code)
+ * \brief Translate between signed linear and LPC10 (Linear Predictor Code)
 *
 */

--- a/codecs/codec_speex.c
+++ b/codecs/codec_speex.c
@@ -5,8 +5,6 @@
 *
 * Mark Spencer <markster@digium.com>
 *
- * This work was motivated by Jeremy McNamara 
- * hacked to be configurable by anthm and bkw 9/28/2004
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
@@ -19,10 +17,13 @@
 * at the top of the source tree.
 */

-/*
+/*! \file
 *
- * Translate between signed linear and Speex (Open Codec)
+ * \brief Translate between signed linear and Speex (Open Codec)
 *
+ * http://www.speex.org
+ * \note This work was motivated by Jeremy McNamara 
+ * hacked to be configurable by anthm and bkw 9/28/2004
 */

 #include <fcntl.h>
--- a/codecs/codec_ulaw.c
+++ b/codecs/codec_ulaw.c
@@ -16,9 +16,9 @@
 * at the top of the source tree.
 */

-/* 
+/*! \file
 *
- * codec_ulaw.c - translate between signed linear and ulaw
+ * \brief codec_ulaw.c - translate between signed linear and ulaw
 * 
 */

--- a/codecs/g723_slin_ex.h
+++ b/codecs/g723_slin_ex.h
@@ -1,9 +1,9 @@
-/*
-  * 8-bit raw data
+/*! \file
+  * \brief 8-bit raw data
  *
  * Source: g723.example
  *
-  * Copyright (C) 1999, Mark Spencer
+  * Copyright (C) 1999-2005, Digium, Inc.
  *
  * Distributed under the terms of the GNU General Public License
  *
--- a/codecs/g726_slin_ex.h
+++ b/codecs/g726_slin_ex.h
@@ -1,11 +1,11 @@
-/*
+/*! \file
 * adpcm_slin_ex.h --
 *
- *	4-bit G.726 data, 20 milliseconds worth at 8 kHz.
+ * \brief	4-bit G.726 data, 20 milliseconds worth at 8 kHz.
 *
 * Source: g726.example
 *
- * Copyright (C) 2001, Linux Support Services, Inc.
+ * Copyright (C) 2001-2005, Digium, Inc.
 *
 * Distributed under the terms of the GNU General Public License
 *
--- a/codecs/gsm_slin_ex.h
+++ b/codecs/gsm_slin_ex.h
@@ -1,9 +1,9 @@
-/*
-  * 8-bit raw data
+/*! \file
+  * \brief 8-bit raw data
  *
  * Source: gsm.example
  *
-  * Copyright (C) 1999, Mark Spencer
+  * Copyright (C) 1999-2005, Digium Inc.
  *
  * Distributed under the terms of the GNU General Public License
  *
--- a/codecs/ilbc_slin_ex.h
+++ b/codecs/ilbc_slin_ex.h
@@ -1,9 +1,9 @@
-/*
-  * Raw 8-bit data
+/*! \file
+  * \brief Raw 8-bit data
  *
  * Source: ilbc.out
  *
-  * Copyright (C) 1999, Mark Spencer and Linux Support Services
+  * Copyright (C) 1999-2005, Digium Inc.
  *
  * Distributed under the terms of the GNU General Public License
  *
--- a/codecs/log2comp.h
+++ b/codecs/log2comp.h
@@ -1,10 +1,10 @@
-/* log2comp.h - various base 2 log computation versions
+/*! \file \brief log2comp.h - various base 2 log computation versions
 * 
 * Asterisk -- A telephony toolkit for Linux.
 *
- * Implementation by Alex Volkov <codepro@usa.net>
+ * \author Alex Volkov <codepro@usa.net>
 *
- * Copyright (c) 2004 - 2005, Digium
+ * Copyright (c) 2004 - 2005, Digium Inc.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License
--- a/codecs/lpc10_slin_ex.h
+++ b/codecs/lpc10_slin_ex.h
@@ -1,9 +1,9 @@
-/*
-  * 8-bit raw data
+/*! \file
+  * \brief 8-bit raw data
  *
  * Source: example.lpc10
  *
-  * Copyright (C) 1999, Mark Spencer and Linux Support Services
+  * Copyright (C) 1999-2005, Digium Inc.
  *
  * Distributed under the terms of the GNU General Public License
  *
--- a/codecs/slin_adpcm_ex.h
+++ b/codecs/slin_adpcm_ex.h
@@ -1,11 +1,11 @@
-/*
- * slin_adpcm_ex.h --
+/*! \file
+ * \brief slin_adpcm_ex.h --
 *
 *	Signed 16-bit audio data, 10 milliseconds worth at 8 kHz.
 *
 * Source: g723.example
 *
- * Copyright (C) 2001, Linux Support Services, Inc.
+ * Copyright (C) 2001-2005, Digium Inc.
 *
 * Distributed under the terms of the GNU General Public License
 *
--- a/codecs/slin_g723_ex.h
+++ b/codecs/slin_g723_ex.h
@@ -1,9 +1,9 @@
-/*
-  * Signed 16-bit audio data
+/*! \file
+  * \brief Signed 16-bit audio data
  *
  * Source: g723.example
  *
-  * Copyright (C) 1999, Mark Spencer
+  * Copyright (C) 1999-2005, Digium Inc.
  *
  * Distributed under the terms of the GNU General Public License
  *
--- a/codecs/slin_g726_ex.h
+++ b/codecs/slin_g726_ex.h
@@ -1,11 +1,11 @@
-/*
- * slin_adpcm_ex.h --
+/*! \file
+ * \brief slin_adpcm_ex.h --
 *
 *	Signed 16-bit audio data, 10 milliseconds worth at 8 kHz.
 *
 * Source: g726.example
 *
- * Copyright (C) 2001, Linux Support Services, Inc.
+ * Copyright (C) 2001-2005, Digium Inc.
 *
 * Distributed under the terms of the GNU General Public License
 *
--- a/codecs/slin_gsm_ex.h
+++ b/codecs/slin_gsm_ex.h
@@ -1,9 +1,9 @@
-/*
-  * Signed 16-bit audio data
+/*! \file
+  * \brief Signed 16-bit audio data
  *
  * Source: gsm.example
  *
-  * Copyright (C) 1999, Mark Spencer
+  * Copyright (C) 1999-2005, Digium Inc.
  *
  * Distributed under the terms of the GNU General Public License
  *
--- a/codecs/slin_ilbc_ex.h
+++ b/codecs/slin_ilbc_ex.h
@@ -1,9 +1,9 @@
-/*
-  * Signed 16-bit audio data
+/*! \file
+  * \brief Signed 16-bit audio data
  *
  * Source: gsm.example
  *
-  * Copyright (C) 1999, Mark Spencer
+  * Copyright (C) 1999-2005, Digium Inc
  *
  * Distributed under the terms of the GNU General Public License
  *
--- a/codecs/slin_lpc10_ex.h
+++ b/codecs/slin_lpc10_ex.h
@@ -1,9 +1,9 @@
-/*
-  * Signed 16-bit audio data
+/*! \file
+  * \brief Signed 16-bit audio data
  *
  * Source: example.slin
  *
-  * Copyright (C) 1999, Mark Spencer and Linux Support Services
+  * Copyright (C) 1999-2005, Digium Inc.
  *
  * Distributed under the terms of the GNU General Public License
  *
--- a/codecs/slin_speex_ex.h
+++ b/codecs/slin_speex_ex.h
@@ -1,9 +1,9 @@
-/*
- * Signed 16-bit audio data, 500ms of speech at 8kHz to ensure no DTX triggered
+/*! \file
+ * \brief Signed 16-bit audio data, 500ms of speech at 8kHz to ensure no DTX triggered
 *
 * Source: speex.example
 *
- * Copyright (C) 1999, Mark Spencer
+ * Copyright (C) 1999-2005, Digium Inc.
 *
 * Distributed under the terms of the GNU General Public License
 *
--- a/codecs/slin_ulaw_ex.h
+++ b/codecs/slin_ulaw_ex.h
@@ -1,11 +1,11 @@
-/*
- * slin_ulaw_ex.h --
+/*! \file
+ * \brief slin_ulaw_ex.h --
 *
 *	Signed 16-bit audio data, 10 milliseconds worth at 8 kHz.
 *
 * Source: g723.example
 *
- * Copyright (C) 2001, Linux Support Services, Inc.
+ * Copyright (C) 2001-2005, Digium Inc.
 *
 * Distributed under the terms of the GNU General Public License
 *
--- a/codecs/speex_slin_ex.h
+++ b/codecs/speex_slin_ex.h
@@ -1,9 +1,9 @@
-/*
-  * Random Data data
+/*! \file
+  * \brief Random Data data
  *
  * Source: speex.raw
  *
-  * Copyright (C) 1999, Mark Spencer and Linux Support Services
+  * Copyright (C) 1999-2005, Digium Inc.
  *
  * Distributed under the terms of the GNU General Public License
  *
--- a/codecs/ulaw_slin_ex.h
+++ b/codecs/ulaw_slin_ex.h
@@ -1,11 +1,11 @@
-/*
- * ulaw_slin_ex.h --
+/*! \file
+ * \brief ulaw_slin_ex.h --
 *
 *	4-bit ADPCM data, 20 milliseconds worth at 8 kHz.
 *
 * Source: g723.example
 *
- * Copyright (C) 2001, Linux Support Services, Inc.
+ * Copyright (C) 2001-2005, Digium Inc.
 *
 * Distributed under the terms of the GNU General Public License
 *