annotate parser-mecmd.h @ 25553:6ac1ece1f9fe

Add multiple inclusion guards to all header files that lack them.
author diego
date Tue, 01 Jan 2008 21:35:58 +0000
parents 1a14fde7680d
children 4129c8cfa742
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25553
6ac1ece1f9fe Add multiple inclusion guards to all header files that lack them.
diego
parents: 18265
diff changeset
1 #ifndef PARSER_MECMD_H
6ac1ece1f9fe Add multiple inclusion guards to all header files that lack them.
diego
parents: 18265
diff changeset
2 #define PARSER_MECMD_H
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
3
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
4 /// \file
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
5 /// \ingroup ConfigParsers MEntry
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
6 /// \brief A simple parser with per-entry settings.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
7
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
8 /// \defgroup MEntry MEncoder's playlist
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
9 ///@{
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
10
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
11 /// Playlist entry
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
12 typedef struct m_entry_st {
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
13 /// Filename, url or whatever.
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
14 char* name;
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
15 /// NULL terminated list of name,val pairs.
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
16 char** opts;
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
17 } m_entry_t;
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
18
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
19 /// 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
20 void
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
21 m_entry_list_free(m_entry_t* lst);
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
22
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
23 /// Helper to set all config options from an entry.
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
24 int
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
25 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
26
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
27 /// Setup the \ref Config from command line arguments and build a playlist.
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
28 /** \ingroup ConfigParsers
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
29 */
8164
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
30 m_entry_t*
487cfc28525d New config system + cleanup of header inter dependency
albeu
parents:
diff changeset
31 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
32
18265
1a14fde7680d Doxygen Attack! - Chapter 3
albeu
parents: 8164
diff changeset
33 ///@}
25553
6ac1ece1f9fe Add multiple inclusion guards to all header files that lack them.
diego
parents: 18265
diff changeset
34
6ac1ece1f9fe Add multiple inclusion guards to all header files that lack them.
diego
parents: 18265
diff changeset
35 #endif /* PARSER_MECMD_H */