QPQ-AG/getopt
11
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added edoc comments.

Browse Source
This commit is contained in:
Juan Jose Comellas
2009-10-06 17:03:51 -03:00
parent 7fcdbbe777
commit 468002ff8e
3 changed files with 19 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/getopt.hrl
+7 -9
View File
@@ -1,16 +1,14 @@
%%%-------------------------------------------------------------------
%%% @author Juan Jose Comellas <jcomellas@novamens.com>
%%% @copyright (C) 2009, Novamens SA (http://www.novamens.com)
%%% @doc Records used by the getopt module.
%%%-------------------------------------------------------------------
%% @doc Atom indicating the data type that an argument can be converted to.
%% @type getopt_arg_type() = 'atom' | 'binary' | 'bool' | 'float' | 'integer' | 'string'.
%% Atom indicating the data type that an argument can be converted to.
-type getopt_arg_type() :: 'atom' | 'binary' | 'boolean' | 'float' | 'integer' | 'string'.
%% @doc Data type that an argument can be converted to.
%% @type getopt_arg() = atom() | binary() | bool() | float() | integer() | string().
%% Data type that an argument can be converted to.
-type getopt_arg() :: atom() | binary() | boolean() | float() | integer() | string().
%% @@doc Argument specification.
%% @type getopt_arg_spec() = getopt_arg_type() | {getopt_arg_type(), getopt_arg()} | help | undefined.
%% Argument specification.
-type getopt_arg_spec() :: getopt_arg_type() | {getopt_arg_type(), getopt_arg()} | help | undefined.
%% @doc Record that defines the option specifications.
-record(option, {
%% @doc Name of the option
name :: atom(),