[Mplayer-cvslog] CVS: main edl.c,1.1,1.2 edl.h,1.3,1.4

[Sascha Sommer CVS]

CVS change done by Sascha Sommer CVS

Update of /cvsroot/mplayer/main
In directory mail:/var2/tmp/cvs-serv10200

Modified Files:
	edl.c edl.h 
Log Message:
doxygen style comments, patch by Reynaldo H. Verdejo Pinochet <reynaldo at opendot.cl>

Index: edl.c
===================================================================
RCS file: /cvsroot/mplayer/main/edl.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- edl.c	28 Aug 2004 00:46:05 -0000	1.1
+++ edl.c	16 Sep 2004 09:35:42 -0000	1.2
@@ -8,6 +8,12 @@
 
 int edl_check_mode(void)
 {
+/** Makes sure that edl has been called
+ * in one of his operating modes but not both
+ * we cant do -edl and -edlout at the same time
+ * so we return EDL_ERROR when this happens.
+ * 1 otherwise.
+ */
     if (edl_filename && edl_output_filename)
     {
         return (EDL_ERROR);
@@ -18,6 +24,10 @@
 
 int edl_count_entries(void)
 {
+/** Calculates the total amount edl_records we will need
+ * to hold the edl operations queue, we need one edl_record
+ * for each SKIP and two for each MUTE, returns total needed.
+ */
     FILE *fd = NULL;
     int entries = 0;
     int action = 0;
@@ -63,6 +73,11 @@
 
 int edl_parse_file(edl_record_ptr edl_records)
 {
+/** fills the edl operations queue,
+ * returns No of edl records stored, EDL_ERROR when
+ * cannot read from file.
+ */
+ 
     FILE *fd;
     char line[100];
     float start, stop;
@@ -109,7 +124,7 @@
                                "Invalid EDL line [%d]: %s", lineCount,
                                line);
                         mp_msg(MSGT_CPLAYER, MSGL_WARN,
-                               "Stop time must follow start time. Discarding!\n");
+                               "Stop time has to be after start time. Discarding!\n");
                         continue;
                     }
                     next_edl_record->action = action;

Index: edl.h
===================================================================
RCS file: /cvsroot/mplayer/main/edl.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- edl.h	28 Aug 2004 00:46:05 -0000	1.3
+++ edl.h	16 Sep 2004 09:35:42 -0000	1.4
@@ -23,11 +23,11 @@
 
 typedef struct edl_record* edl_record_ptr;
 
-char *edl_filename; // file to extract edl entries from (-edl)
-char *edl_output_filename; // file to put edl entries in (-edlout)
+char *edl_filename; /// file to extract edl entries from (-edl)
+char *edl_output_filename; /// file to put edl entries in (-edlout)
 
-int edl_check_mode(void); // we cannot do -edl and -edlout at the same time
-int edl_count_entries(void); // returns total No of entries needed
-int edl_parse_file(edl_record_ptr edl_records); // fills edl stack
+int edl_check_mode(void); /// we cannot do -edl and -edlout at the same time
+int edl_count_entries(void); /// returns total No of entries needed
+int edl_parse_file(edl_record_ptr edl_records); /// fills edl queue 
 
 #endif