Revision 15067504 cmdutils.h

View differences:

cmdutils.h
25 25
#include <inttypes.h>
26 26

  
27 27
/**
28
 * parses a string and returns its corresponding value as a double or
29
 * exits from the application if the string cannot be correctly parsed
30
 * or the corresponding value is invalid
28
 * Parses a string and returns its corresponding value as a double.
29
 * Exits from the application if the string cannot be correctly
30
 * parsed or the corresponding value is invalid.
31 31
 *
32 32
 * @param context the context of the value to be set (e.g. the
33 33
 * corresponding commandline option name)
34 34
 * @param numstr the string to be parsed
35 35
 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
36 36
 * string should be parsed
37
 * @param min the minimum valid value accepted
38
 * @param max the maximum valid value accepted
37
 * @param min the minimum valid accepted value
38
 * @param max the maximum valid accepted value
39 39
 */
40 40
double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
41 41

  
......
82 82
void print_error(const char *filename, int err);
83 83

  
84 84
/**
85
 * Prints the banner of the program on stderr. The banner message
86
 * depends on the current versions of the repository and of the libav*
87
 * libraries.
88
 * @param program_name Name of the program.
89
 * @param program_birth_year Year of birth of the program.
85
 * Prints the program banner to stderr. The banner contents depend on the
86
 * current version of the repository and of the libav* libraries used by
87
 * the program.
88
 * @param program_name name of the program
89
 * @param program_birth_year year of birth of the program
90 90
 */
91 91
void show_banner(const char *program_name, int program_birth_year);
92 92

  
93 93
/**
94
 * Prints the version of the program on stdout. The version message
94
 * Prints the version of the program to stdout. The version message
95 95
 * depends on the current versions of the repository and of the libav*
96 96
 * libraries.
97
 * @param program_name Name of the program.
97
 * @param program_name name of the program
98 98
 */
99 99
void show_version(const char *program_name);
100 100

  
101 101
/**
102
 * Prints on stdout the license of the program, which depends on the license of
103
 * the compiled libav* libraries.
102
 * Prints the license of the program to stdout. The license depends on
103
 * the license of the libraries compiled into the program.
104 104
 */
105 105
void show_license(void);
106 106

  

Also available in: Unified diff