annotate parser-mecmd.h @ 33571:4f9ad91c79b4

Add const to string pointer argument that will not be modified.

/*
 * This file is part of MPlayer.
 *
 * MPlayer is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * MPlayer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef MPLAYER_PARSER_MECMD_H
#define MPLAYER_PARSER_MECMD_H

#include "m_config.h"

/// \file
/// \ingroup ConfigParsers MEntry
/// \brief A simple parser with per-entry settings.

/// \defgroup MEntry MEncoder's playlist
///@{

/// Playlist entry
typedef struct m_entry_st {
  /// Filename, url or whatever.
  char* name;
  /// NULL terminated list of name,val pairs.
  char** opts;
} m_entry_t;

/// Free a list returned by \ref m_config_parse_me_command_line.
void
m_entry_list_free(m_entry_t* lst);

/// Helper to set all config options from an entry.
int
m_entry_set_options(m_config_t *config, m_entry_t* entry);

/// Setup the \ref Config from command line arguments and build a playlist.
/** \ingroup ConfigParsers
 */
m_entry_t*
m_config_parse_me_command_line(m_config_t *config, int argc, char **argv);

///@}

#endif /* MPLAYER_PARSER_MECMD_H */