[hipl-dev] Re: [Branch ~toxedvirus/hipl/hipfw-modules] Rev 5009: Add documentation for hip_cmd_options_parase, add documentation for missing paramter, fix typo in...

  • From: Diego Biurrun <diego@xxxxxxxxxx>
  • To: hipl-dev@xxxxxxxxxxxxx
  • Date: Wed, 03 Nov 2010 19:27:51 +0100

On Wed, Nov 03, 2010 at 05:11:29PM +0000, noreply@xxxxxxxxxxxxx wrote:
> ------------------------------------------------------------
> revno: 5009
> committer: Andrius Bentkus <andrius.bentkus@xxxxxxxxxxxxxx>
> branch nick: hipfw-modules
> timestamp: Wed 2010-11-03 18:09:38 +0100
> message:
>   Add documentation for hip_cmd_options_parase, add documentation for missing 
> paramter, fix typo in documentation.
> modified:
>   lib/core/options.c
> 
> --- lib/core/options.c        2010-11-03 16:46:44 +0000
> +++ lib/core/options.c        2010-11-03 17:09:38 +0000
> @@ -224,6 +224,7 @@
>   *
>   * @param list    Pointer to list, head must be initialized with NULL.
>   * @param options Pointer to options to be added.
> + * @param size    Count of elemnts in the options struct

elemEnts

I would like to politely suggest to spellcheck your documentation changes
since you do make a fair number of typos.

> @@ -302,6 +303,10 @@
>   * @param argc Argument count.
>   * @param argv Array of argument strings.
>   * @param list List of options to check against.
> + * @return     1 if the missing_option   handle is not existent but needed,
> + *             2 if the missing_argument handle is not existent but needed,
> + *             Passes the error code of the option handler if it faces some 
> error,

the option handler error code on errors

Diego

Other related posts:

  1. Home
  2. hipl-dev
  3. Archive
  4. 11-2010