OpenEuphoria

Idea for documentation makeover

• Posted by _tom (admin) Nov 16, 2012
• 1127 views

• An idea for a documentation makeover. This look can be achieved without rewriting the current documentation.

cmd_parse

parses command line options and optionally calls procedures based on these options.

cmd_parse( S1_opts , O2_{parse_options = {}} , S3_{cmds = command_line()} )

include cmdline.e 
namespace cmdline 
public function 

Arguments:

S1 _opts

a sequence of records that define the various command line switches and options that are valid for the application: See Comments: section for details

O2 _{parse_options = {}}

an optional list of special behavior modifiers: See Parse Options section for details

S3 _{cmds = command_line()}

an optional sequence of command line arguments. If omitted the output from command_line is used.

• This is how the documentation looks currently.

cmd_parse

include cmdline.e 
namespace cmdline 
public function cmd_parse(sequence opts, object parse_options = {}, 
        sequence cmds = command_line()) 

parses command line options and optionally calls procedures based on these options.

Parameters:

1. opts : a sequence of records that define the various command line switches and options that are valid for the application: See Comments: section for details
2. parse_options : an optional list of special behavior modifiers: See Parse Options section for details
3. cmds : an optional sequence of command line arguments. If omitted the output from command_line is used.

• Any ideas or suggestions?

TOM