dox

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@5176 d0543943-73ff-0310-b7d9-9358b9ac24b2

docs/Doxygen.conf

@@ -83,7 +83,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = ../src ../src/include 
+INPUT                  = ../src ../src/include ../src/include/private
 FILE_PATTERNS          = *.c \
                          *.cc \
                          *.cxx \

src/include/switch_apr.h

@@ -167,7 +167,7 @@ SWITCH_DECLARE(switch_hash_index_t *) switch_hash_first(switch_memory_pool_t *p,
 
 /**
  * Continue iterating over the entries in a hash table.
- * @param hi The iteration state
+ * @param ht The iteration state
  * @return a pointer to the updated iteration state.  NULL if there are no more  
  *         entries.
  */
@@ -520,7 +520,7 @@ SWITCH_DECLARE(switch_status_t) switch_uuid_parse(switch_uuid_t * uuid, const ch
  * create a FIFO queue
  * @param queue The new queue
  * @param queue_capacity maximum size of the queue
- * @param a pool to allocate queue from
+ * @param pool a pool to allocate queue from
  */
 SWITCH_DECLARE(switch_status_t) switch_queue_create(switch_queue_t ** queue, unsigned int queue_capacity, switch_memory_pool_t *pool);
 
@@ -684,7 +684,7 @@ SWITCH_DECLARE(switch_status_t) switch_file_seek(switch_file_t * thefile, switch
 
 /**
  * Close the specified file.
- * @param file The file descriptor to close.
+ * @param thefile The file descriptor to close.
  */
 SWITCH_DECLARE(switch_status_t) switch_file_close(switch_file_t * thefile);
 
@@ -771,7 +771,7 @@ SWITCH_DECLARE(switch_status_t) switch_threadattr_stacksize_set(switch_threadatt
 /**
  * Create and initialize a new threadattr variable
  * @param new_attr The newly created threadattr.
- * @param cont The pool to use
+ * @param pool The pool to use
  */
 SWITCH_DECLARE(switch_status_t) switch_threadattr_create(switch_threadattr_t ** new_attr, switch_memory_pool_t *pool);
 
@@ -904,7 +904,7 @@ SWITCH_DECLARE(switch_status_t) switch_socket_listen(switch_socket_t * sock, int
  *                 made the connection request.  This is the socket which should
  *                 be used for all future communication.
  * @param sock The socket we are listening on.
- * @param connection_pool The pool for the new socket.
+ * @param pool The pool for the new socket.
  */
 SWITCH_DECLARE(switch_status_t) switch_socket_accept(switch_socket_t ** new_sock, switch_socket_t * sock, switch_memory_pool_t *pool);
 
@@ -943,7 +943,7 @@ SWITCH_DECLARE(switch_status_t) switch_sockaddr_ip_get(char **addr, switch_socka
  *                                 isn't NULL and APR_HAVE_IPV6; mutually exclusive
  *                                 with APR_IPV4_ADDR_OK
  * </PRE>
- * @param p The pool for the apr_sockaddr_t and associated storage.
+ * @param pool The pool for the apr_sockaddr_t and associated storage.
  */
 SWITCH_DECLARE(switch_status_t) switch_sockaddr_info_get(switch_sockaddr_t ** sa, const char *hostname,
 														 int32_t family, switch_port_t port, int32_t flags, switch_memory_pool_t *pool);
@@ -1148,7 +1148,6 @@ SWITCH_DECLARE(switch_status_t) switch_socket_create_pollfd(switch_pollfd_t ** p
 
 
 
-/** @} */
 /** @} */
 
 SWITCH_END_EXTERN_C

src/include/switch_core_event_hook.h

@@ -226,7 +226,7 @@ SWITCH_DECLARE(switch_status_t) switch_core_event_hook_add_write_frame(switch_co
 /*! 
   \brief Add an event hook to be executed when a session writes a video frame
   \param session session to bind hook to
-  \param write_frame hook to bind
+  \param video_write_frame hook to bind
   \return SWITCH_STATUS_SUCCESS on suceess
 */
 SWITCH_DECLARE(switch_status_t) switch_core_event_hook_add_video_write_frame(switch_core_session_t *session, switch_video_write_frame_hook_t video_write_frame);

src/include/switch_regex.h

@@ -36,7 +36,7 @@
 
 SWITCH_BEGIN_EXTERN_C
 /**
- * @defgroup switch_regex
+ * @defgroup switch_regex Regular Expressions
  * @ingroup FREESWITCH
  * @{
  */

src/include/switch_scheduler.h

@@ -51,7 +51,7 @@ SWITCH_BEGIN_EXTERN_C
 
 /*!
   \brief Schedule a task in the future
-  \param runtime the time in epoch seconds to execute the task.
+  \param task_runtime the time in epoch seconds to execute the task.
   \param func the callback function to execute when the task is executed.
   \param desc an arbitrary description of the task.
   \param group a group id tag to link multiple tasks to a single entity.

src/switch_core.c

@@ -35,7 +35,7 @@
 
 #include <switch.h>
 #include <switch_version.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 SWITCH_DECLARE_DATA switch_directories SWITCH_GLOBAL_dirs = { 0 };
 

src/switch_core_asr.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 SWITCH_DECLARE(switch_status_t) switch_core_asr_open(switch_asr_handle_t *ah,
 													 char *module_name,

src/switch_core_codec.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 SWITCH_DECLARE(switch_status_t) switch_core_session_set_read_codec(switch_core_session_t *session, switch_codec_t *codec)
 {

src/switch_core_db.c

@@ -31,7 +31,7 @@
  */
 
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 #include <sqlite3.h>
 

src/switch_core_directory.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 SWITCH_DECLARE(switch_status_t) switch_core_directory_open(switch_directory_handle_t *dh,
 														   char *module_name, char *source, char *dsn, char *passwd, switch_memory_pool_t *pool)

src/switch_core_event_hook.c

@@ -29,7 +29,7 @@
  *
  */
 #include "switch.h"
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 SWITCH_DECLARE(switch_status_t) switch_core_event_hook_add_outgoing(switch_core_session_t *session, switch_outgoing_channel_hook_t outgoing_channel)
 {

src/switch_core_file.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 SWITCH_DECLARE(switch_status_t) switch_core_file_open(switch_file_handle_t *fh,
 													  char *file_path, uint8_t channels, uint32_t rate, unsigned int flags, switch_memory_pool_t *pool)

src/switch_core_hash.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 SWITCH_DECLARE(switch_status_t) switch_core_hash_init(switch_hash_t ** hash, switch_memory_pool_t *pool)
 {

src/switch_core_io.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 
 SWITCH_DECLARE(switch_status_t) switch_core_session_write_video_frame(switch_core_session_t *session, switch_frame_t *frame, int timeout, int stream_id)

src/switch_core_media_bug.c

@@ -32,7 +32,7 @@
  *
  */
 #include "switch.h"
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 static void switch_core_media_bug_destroy(switch_media_bug_t *bug)
 {

src/switch_core_memory.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 static struct {
 	switch_memory_pool_t *memory_pool;

src/switch_core_port_allocator.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 struct switch_core_port_allocator {
 	switch_port_t start;

src/switch_core_rwlock.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 #ifdef SWITCH_DEBUG_RWLOCKS
 SWITCH_DECLARE(switch_status_t) switch_core_session_perform_read_lock(switch_core_session_t *session, const char *file, const char *func, int line)

src/switch_core_session.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 static struct {
 	switch_memory_pool_t *memory_pool;

src/switch_core_speech.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 SWITCH_DECLARE(switch_status_t) switch_core_speech_feed_tts(switch_speech_handle_t *sh, char *text, switch_speech_flag_t *flags)
 {

src/switch_core_sqldb.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 static struct {
 	switch_core_db_t *db;

src/switch_core_state_machine.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 static void switch_core_standard_on_init(switch_core_session_t *session)
 {

src/switch_core_timer.c

@@ -32,7 +32,7 @@
  *
  */
 #include <switch.h>
-#include "private/switch_core.h"
+#include "private/switch_core_pvt.h"
 
 SWITCH_DECLARE(switch_status_t) switch_core_timer_init(switch_timer_t *timer, char *timer_name, int interval, int samples, switch_memory_pool_t *pool)
 {