Changeset 2037 for pjproject/trunk/pjmedia/include/pjmedia/port.h

Timestamp:

Jun 20, 2008 9:39:02 PM (16 years ago)

Author:

bennylp

Message:

Updated doxygen documentations

File:

• pjproject/trunk/pjmedia/include/pjmedia/port.h (modified) (9 diffs)

pjproject/trunk/pjmedia/include/pjmedia/port.h

@@ -29 +29 @@
 
 /**
-  @defgroup PJMEDIA_PORT_CONCEPT Media Ports Framework
-  @ingroup PJMEDIA
-  @brief Extensible framework for media terminations
-  
+  @addtogroup PJMEDIA_PORT Media Ports Framework
+  @{
+
   @section media_port_intro Media Port Concepts
   
@@ -166 +165 @@
   among media ports. This concept is described in @ref PJMEDIA_PORT_CLOCK 
   section.
-
- */
-
-
-/**
- * @defgroup PJMEDIA_PORT_INTERFACE Media Port Interface
- * @ingroup PJMEDIA_PORT_CONCEPT
- * @brief Declares the media port interface.
- */
-
-/**
- * @defgroup PJMEDIA_PORT Ports
- * @ingroup PJMEDIA_PORT_CONCEPT
- * @brief Contains various types of media ports/terminations.
- * @{
- * This page lists all types of media ports currently implemented
- * in PJMEDIA. The media port concept is explained in @ref PJMEDIA_PORT_CONCEPT.
- * @}
- */
-
-/**
- @defgroup PJMEDIA_PORT_CLOCK Clock/Timing
- @ingroup PJMEDIA_PORT_CONCEPT
- @brief Various types of classes that provide timing.
- @{
-
- The media clock/timing extends the media port concept that is explained 
- in @ref PJMEDIA_PORT_CONCEPT. When clock is present in the ports 
- interconnection, media will flow automatically (and with correct timing too!)
- from one media port to another.
- 
- There are few objects in PJMEDIA that are able to provide clock/timing
- to media ports interconnection:
-
- - @ref PJMED_SND_PORT\n
-   The sound device makes a good candidate as the clock source, and
-   PJMEDIA @ref PJMED_SND is designed so that it is able to invoke
-   operations according to timing driven by the sound hardware clock
-   (this may sound complicated, but actually it just means that
-   the sound device abstraction provides callbacks to be called when
-   it has/wants media frames).\n
-   See @ref PJMED_SND_PORT for more details.
-
- - @ref PJMEDIA_MASTER_PORT\n
-   The master port uses @ref PJMEDIA_CLOCK as the clock source. By using
-   @ref PJMEDIA_MASTER_PORT, it is possible to interconnect passive
-   media ports and let the frames flow automatically in timely manner.\n
-   Please see @ref PJMEDIA_MASTER_PORT for more details.
-
- @}
- */
-
-/**
- * @addtogroup PJMEDIA_PORT_INTERFACE
- * @{
- * This page contains the media port interface declarations. The media port
- * concept is explained in @ref PJMEDIA_PORT_CONCEPT.
- */
+*/
 
 PJ_BEGIN_DECL
@@ -231 +173 @@
  * Port operation setting.
  */
-enum pjmedia_port_op
+typedef enum pjmedia_port_op
 {
     /** 
@@ -254 +196 @@
      */
     PJMEDIA_PORT_ENABLE
-};
-
-
-/**
- * @see pjmedia_port_op
- */
-typedef enum pjmedia_port_op pjmedia_port_op;
+
+} pjmedia_port_op;
 
 
@@ -297 +234 @@
  * This structure describes a media frame. 
  */
-struct pjmedia_frame
+typedef struct pjmedia_frame
 {
     pjmedia_frame_type   type;      /**< Frame type.                        */
@@ -308 +245 @@
                                          may be used for specifying start & 
                                          end bit offset.                    */
-};
-
-
-/** 
- * @see pjmedia_frame
- */
-typedef struct pjmedia_frame pjmedia_frame;
-
-
-/**
- * For future graph.
- */
-typedef struct pjmedia_graph pjmedia_graph;
-
-
-/**
- * @see pjmedia_port
- */
-typedef struct pjmedia_port pjmedia_port;
+} pjmedia_frame;
+
 
 /**
  * Port interface.
  */
-struct pjmedia_port
+typedef struct pjmedia_port
 {
     pjmedia_port_info    info;              /**< Port information.  */
@@ -347 +267 @@
      * This should only be called by #pjmedia_port_put_frame().
      */
-    pj_status_t (*put_frame)(pjmedia_port *this_port, 
+    pj_status_t (*put_frame)(struct pjmedia_port *this_port, 
                              const pjmedia_frame *frame);
 
@@ -354 +274 @@
      * This should only be called by #pjmedia_port_get_frame().
      */
-    pj_status_t (*get_frame)(pjmedia_port *this_port, 
+    pj_status_t (*get_frame)(struct pjmedia_port *this_port, 
                              pjmedia_frame *frame);
 
@@ -360 +280 @@
      * Called to destroy this port.
      */
-    pj_status_t (*on_destroy)(pjmedia_port *this_port);
-};
+    pj_status_t (*on_destroy)(struct pjmedia_port *this_port);
+
+} pjmedia_port;