Add doxygen comments for various structs.

[paraslash.git] / ortp_send.c

diff --git a/ortp_send.c b/ortp_send.c
index 084fdf5753aaaaa610b9209235bccae803dd3052..0c6cccb902a7be84f0f4ce1d40c699c7ff544cda 100644 (file)
--- a/ortp_send.c
+++ b/ortp_send.c
@@ -21,27 +21,26 @@
 #include "list.h"
 #include "ortp.h"
 
-/** \cond convert in_addr to ascii */
+/** Convert in_addr to ascii. */
 #define TARGET_ADDR(oc) inet_ntoa((oc)->addr)
-/** \endcond */
 
-/** describes one entry in the list of targets for the ortp sender */
+/** Describes one entry in the list of targets for the ortp sender. */
 struct ortp_target {
-/** address info */
+       /** Address info. */
        struct in_addr addr;
-/** whether the ortp sender is activated */
+       /** Whether the ortp sender is activated. */
        int status;
-/** the ortp timestamp increases by this amount */
+       /** The ortp timestamp increases by this amount. */
        uint32_t chunk_ts;
-/** the currently used timestamp for this target */
+       /** The currently used timestamp for this target. */
        uint32_t last_ts;
-/** the position of this target in the list of targets */
+       /** The position of this target in the list of targets. */
        struct list_head node;
-/** the UDP port */
+       /** The UDP port. */
        int port;
-/** non-zero if at least one chunk has been sent to this target */
+       /** Non-zero if at least one chunk has been sent to this target. */
        int streaming;
-/** the session pointer from libortp */
+       /** The session pointer from libortp. */
        RtpSession *session;
 };