annotate parser-mecmd.h @ 26404:d549dcb766df

Fix DEPEND_CMD, there was one level of variable indirection too much.
author diego
date Sun, 13 Apr 2008 10:59:11 +0000
parents 83c95bd31aab
children c1a3f1bbba26
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26029
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 25553
diff changeset
1 #ifndef MPLAYER_PARSER_MECMD_H
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 25553
diff changeset
2 #define MPLAYER_PARSER_MECMD_H
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
3
26131
83c95bd31aab Add necessary #includes to pass 'make checkheaders'.
diego
parents: 26029
diff changeset
4 #include "m_config.h"
83c95bd31aab Add necessary #includes to pass 'make checkheaders'.
diego
parents: 26029
diff changeset
5
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
6 /// \file
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
7 /// \ingroup ConfigParsers MEntry
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
8 /// \brief A simple parser with per-entry settings.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
9
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
10 /// \defgroup MEntry MEncoder's playlist
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
11 ///@{
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
12
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
13 /// Playlist entry
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
14 typedef struct m_entry_st {
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
15 /// Filename, url or whatever.
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
16 char* name;
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
17 /// NULL terminated list of name,val pairs.
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
18 char** opts;
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
19 } m_entry_t;
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
20
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
21 /// Free a list returned by \ref m_config_parse_me_command_line.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
22 void
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
23 m_entry_list_free(m_entry_t* lst);
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
24
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
25 /// Helper to set all config options from an entry.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
26 int
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
27 m_entry_set_options(m_config_t *config, m_entry_t* entry);
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
28
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
29 /// Setup the \ref Config from command line arguments and build a playlist.
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
30 /** \ingroup ConfigParsers
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
31 */
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
32 m_entry_t*
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
33 m_config_parse_me_command_line(m_config_t *config, int argc, char **argv);
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
34
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
35 ///@}
25553
6ac1ece1f9fe Add multiple inclusion guards to all header files that lack them.
diego
parents: 18265
diff changeset
36
26029
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 25553
diff changeset
37 #endif /* MPLAYER_PARSER_MECMD_H */