[MPlayer-cvslog] CVS: main m_config.h, 1.8, 1.9 m_option.h, 1.15, 1.16 m_property.h, 1.4, 1.5 m_struct.h, 1.4, 1.5

[Alban Bedel CVS]

CVS change done by Alban Bedel CVS

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

Modified Files:
	m_config.h m_option.h m_property.h m_struct.h 
Log Message:
Fix most of the mistakes pointed out by Diego.


Index: m_config.h
===================================================================
RCS file: /cvsroot/mplayer/main/m_config.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- m_config.h	24 Apr 2006 19:20:03 -0000	1.8
+++ m_config.h	25 Apr 2006 18:48:53 -0000	1.9
@@ -3,8 +3,8 @@
 
 /// \defgroup Config Config manager
 ///
-/// m_config provide an API to manipulate the config variables in MPlayer.
-/// It make use of the \ref Options API to provide a context stack that
+/// m_config provides an API to manipulate the config variables in MPlayer.
+/// It make uses of the \ref Options API to provide a context stack that
 /// allow saving and later restoring the state of all variables.
 ///@{
 
@@ -44,7 +44,7 @@
 /// \defgroup ConfigProfiles Config profiles
 /// \ingroup Config
 ///
-/// Profiles allow to predefine some set of options that can then
+/// Profiles allow to predefine some sets of options that can then
 /// be applied later on with the internal -profile option.
 ///
 ///@{
@@ -65,14 +65,14 @@
 /** \ingroup Config */
 typedef struct m_config {
   /// Registered options.
-  /** This contain all options and suboptions.
+  /** This contains all options and suboptions.
    */ 
   m_config_option_t* opts;
   /// Current stack level.
   int lvl;
   /// \ref OptionParserModes
   int mode;
-  /// List of the defined profiles.
+  /// List of defined profiles.
   m_profile_t* profiles;
   /// Depth when recursively including profiles.
   int profile_depth;
@@ -87,7 +87,7 @@
 /// Set if an option have been set at the current level.
 #define M_CFG_OPT_SET    (1<<0)
 
-/// Set if another option already use the same variable.
+/// Set if another option already uses the same variable.
 #define M_CFG_OPT_ALIAS  (1<<1)
 
 ///@}

Index: m_option.h
===================================================================
RCS file: /cvsroot/mplayer/main/m_option.h,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- m_option.h	24 Apr 2006 19:20:04 -0000	1.15
+++ m_option.h	25 Apr 2006 18:48:53 -0000	1.16
@@ -2,7 +2,7 @@
 #define _M_OPTION_H
 
 /// \defgroup Options
-/// m_option allow to parse, print and copy data of various types.
+/// m_option allows to parse, print and copy data of various types.
 /// It is the base of the \ref OptionsStruct, \ref Config and
 /// \ref Properties APIs.
 ///@{
@@ -81,7 +81,7 @@
 } m_obj_settings_t;
 
 /// A parser to setup a list of objects.
-/** It create a NULL terminated array \ref m_obj_settings. The option priv
+/** It creates a NULL terminated array \ref m_obj_settings. The option priv
  *  field (\ref m_option::priv) must point to a \ref m_obj_list_t describing
  *  the available object types.
  */
@@ -100,7 +100,7 @@
 } m_obj_presets_t;
 
 /// Set several fields in a struct at once.
-/** For this two struct description are used. One for the struct holding the
+/** For this two struct descriptions are used. One for the struct holding the
  *  preset and one for the struct beeing set. Every field present in both
  *  struct will be copied from the preset struct to the destination one.
  *  The option priv field (\ref m_option::priv) must point to a correctly
@@ -116,7 +116,7 @@
 
 /// Extra definition needed for \ref m_option_type_obj_params options.
 typedef struct {
-  /// Fields description.
+  /// Field descriptions.
   struct m_struct_st* desc;
   /// Field separator to use.
   char separator;
@@ -124,7 +124,7 @@
 
 /// Parse a set of parameters.
 /** Parameters are separated by the given separator and each one
- *  successively set a field from the struct. The option priv field
+ *  successively sets a field from the struct. The option priv field
  *  (\ref m_option::priv) must point to a \ref m_obj_params_t.
  */
 extern m_option_type_t m_option_type_obj_params;
@@ -178,10 +178,10 @@
    *  \param opt The option that is parsed.
    *  \param name The full option name.
    *  \param param The parameter to parse.
-   *  \param dst Pointer to the memory where the data should be writen.
+   *  \param dst Pointer to the memory where the data should be written.
    *             If NULL the parameter validity should still be checked.
    *  \param src Source of the option, see \ref OptionParserModes.
-   *  \return On error a negative value is returned, on success the number of argument
+   *  \return On error a negative value is returned, on success the number of arguments
    *          consumed. For details see \ref OptionParserReturn.
    */
   int (*parse)(m_option_t* opt,char *name, char *param, void* dst, int src);
@@ -196,7 +196,7 @@
 
   /** \name
    *  These functions are called to save/set/restore the status of the
-   *  variables. The difference between the 3 only matter for types like 
+   *  variables. The difference between the 3 only matters for types like
    *  \ref m_option_type_func where 'setting' need to do more than just
    *  copying some data.
    */
@@ -243,7 +243,7 @@
   
   /// Reserved for higher level APIs, it shouldn't be used by parsers.
   /** The suboption parser and func types do use it. They should instead
-   *  use the priv field but this was herited from older versions of the
+   *  use the priv field but this was inherited from older versions of the
    *  config code.
    */
   void *p;
@@ -254,15 +254,15 @@
   /// See \ref OptionFlags.
   unsigned int flags;
   
-  /// \brief Mostly usefull for numeric types, the \ref M_OPT_MIN flags must
+  /// \brief Mostly useful for numeric types, the \ref M_OPT_MIN flags must
   /// also be set.
   double min;
 
-  /// \brief Mostly usefull for numeric types, the \ref M_OPT_MAX flags must
+  /// \brief Mostly useful for numeric types, the \ref M_OPT_MAX flags must
   /// also be set.
   double max;
   
-  /// Type dependent data (for all kind of extended setting).
+  /// Type dependent data (for all kind of extended settings).
   /** This used to be function pointer to hold a 'reverse to defaults' func.
    *  Now it can be used to pass any type of extra args needed by the parser.
    *  Passing a 'default func' is still valid for all func based option types
@@ -274,19 +274,19 @@
 /// \defgroup OptionFlags Option flags
 ///@{
 
-/// The option have a minimum set in \ref m_option::min.
+/// The option has a minimum set in \ref m_option::min.
 #define M_OPT_MIN		(1<<0)
 
-/// The option have a maximum set in \ref m_option::max.
+/// The option has a maximum set in \ref m_option::max.
 #define M_OPT_MAX		(1<<1)
 
-/// The option have a minimum and maximum in \ref m_option::min and \ref m_option::max.
+/// The option has a minimum and maximum in \ref m_option::min and \ref m_option::max.
 #define M_OPT_RANGE		(M_OPT_MIN|M_OPT_MAX)
 
 /// The option is forbidden in config files.
 #define M_OPT_NOCFG		(1<<2)
 
-/// The option is forbiden on the command line.
+/// The option is forbidden on the command line.
 #define M_OPT_NOCMD		(1<<3)
 
 /// The option is global in the \ref Config.
@@ -297,8 +297,8 @@
 #define M_OPT_GLOBAL		(1<<4)
 
 /// The \ref Config won't save this option on push.
-/** It won't be saved on push but the command line parser will put it with
- *  it's entry (ie : it may be set later)
+/** It won't be saved on push but the command line parser will add it with
+ *  its entry (ie : it may be set later)
  *  e.g options : -include
  */
 #define M_OPT_NOSAVE		(1<<5)
@@ -335,22 +335,22 @@
  *  array. Only the parse function will be called. If dst is set, it should
  *  create/update an array of char* containg opt/val pairs. The options in
  *  the child array will then be set automatically by the \ref Config.
- *  Also note that sub options may be directly accessed by using
+ *  Also note that suboptions may be directly accessed by using
  *  -option:subopt blah.
  */
 #define M_OPT_TYPE_HAS_CHILD		(1<<0)
 
 /// Wildcard matching flag.
-/** If set the option type have a use for option name ending with a *
- *  (used for -aa*), this only affect the option name matching.
+/** If set the option type has a use for option name ending with a *
+ *  (used for -aa*), this only affects the option name matching.
  */
 #define M_OPT_TYPE_ALLOW_WILDCARD	(1<<1)
 
 /// Dynamic data type.
-/** This flag indicate that the data is dynamicly allocated (m_option::p point
- *  to a pointer). It enable a little hack in the \ref Config wich replace
+/** This flag indicate that the data is dynamically allocated (m_option::p point
+ *  to a pointer). It enables a little hack in the \ref Config wich replace
  *  the initial value of such variables with a dynamic copy in case the
- *  initial value is staticaly allocated (pretty common with strings).
+ *  initial value is statically allocated (pretty common with strings).
  */
 #define M_OPT_TYPE_DYNAMIC		(1<<2)
 
@@ -372,7 +372,7 @@
 /// \defgroup OptionParserModes Option parser modes
 /// \ingroup Options
 ///
-/// Some parser behave differently depending on the mode passed in the src
+/// Some parsers behaves differently depending on the mode passed in the src
 /// parameter of m_option_type::parse. For example the flag type doesn't take
 /// an argument when parsing from the command line.
 ///@{
@@ -387,16 +387,16 @@
 /// \defgroup OptionParserReturn Option parser return code
 /// \ingroup Options
 ///
-/// On sucess parsers return the number of arguments consumed: 0 or 1.
+/// On success parsers return the number of arguments consumed: 0 or 1.
 ///
-/// To indicate that mplayer should exit without playing anything,
+/// To indicate that MPlayer should exit without playing anything,
 /// parsers return M_OPT_EXIT minus the number of parameters they
 /// consumed: \ref M_OPT_EXIT or \ref M_OPT_EXIT-1.
 ///
-/// On error one of the following (negative) error code is returned:
+/// On error one of the following (negative) error codes is returned:
 ///@{
 
-/// For use by higer level APIs when the option name is invalid.
+/// For use by higher level APIs when the option name is invalid.
 #define M_OPT_UNKNOWN		-1
 
 /// Returned when a parameter is needed but wasn't provided.
@@ -419,7 +419,7 @@
 
 /// \defgroup OldOptionParserReturn Backward compatibility
 ///
-/// Those are kept for compatibility with older code.
+/// These are kept for compatibility with older code.
 ///
 ///@{
 #define ERR_NOT_AN_OPTION	M_OPT_UNKNOWN
@@ -432,7 +432,7 @@
 
 /// Find the option matching the given name in the list.
 /** \ingroup Options
- *  This function take the possible wildcards in account (see
+ *  This function takes the possible wildcards into account (see
  *  \ref M_OPT_TYPE_ALLOW_WILDCARD).
  * 
  *  \param list Pointer to an array of \ref m_option.

Index: m_property.h
===================================================================
RCS file: /cvsroot/mplayer/main/m_property.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- m_property.h	24 Apr 2006 19:20:04 -0000	1.4
+++ m_property.h	25 Apr 2006 18:48:53 -0000	1.5
@@ -61,7 +61,7 @@
 /// Returned on error.
 #define M_PROPERTY_ERROR             0
 
-/// \brief Returned when the property can't be used, for ex something about
+/// \brief Returned when the property can't be used, for example something about
 /// the subs while playing audio only
 #define M_PROPERTY_UNAVAILABLE      -1
 
@@ -90,7 +90,7 @@
 
 /// Print the current value of a property.
 /** \param prop The property.
- *  \return A newly allocated string with current value or NULL on error.
+ *  \return A newly allocated string with the current value or NULL on error.
  */
 char* m_property_print(m_option_t* prop);
 
@@ -105,7 +105,7 @@
 void m_properties_print_help_list(m_option_t* list);
 
 /// Expand a property string.
-/** This function allow to print strings containing property values.
+/** This function allows to print strings containing property values.
  *  ${NAME} is expanded to the value of property NAME or an empty
  *  string in case of error. $(NAME:STR) expand STR only if the property
  *  NAME is available.

Index: m_struct.h
===================================================================
RCS file: /cvsroot/mplayer/main/m_struct.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- m_struct.h	24 Apr 2006 19:20:04 -0000	1.4
+++ m_struct.h	25 Apr 2006 18:48:53 -0000	1.5
@@ -12,7 +12,7 @@
 
 /// Struct definition
 typedef struct m_struct_st {
-  /// For error msg and debuging
+  /// For error messages and debugging
   char* name;
   /// size of the whole struct
   unsigned int size;