Skip to content

Commit 1cf6922

Browse files
author
Damien Nadé
committed
argsparse.sh: fixed top-level documentation
1 parent 2d2cc1f commit 1cf6922

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

argsparse.sh

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
#!/bin/bash
22
# -*- tab-width: 4; encoding: utf-8; -*-
33
#
4-
## @file
5-
## @author Damien Nadé <bash-argsparse@livna.org>
6-
## @brief Bash Argsparse Library
7-
## @copyright WTFPLv2
8-
## @version 1.8
9-
#
104
#########
115
# License:
126
#
@@ -26,12 +20,17 @@
2620
#
2721
#########
2822
#
23+
## @file
24+
## @author Damien Nadé <bash-argsparse@livna.org>
25+
## @copyright WTFPLv2
26+
## @version 1.8
27+
## @brief Bash Argsparse Library
2928
## @details
3029
## @par URL
3130
## https://github.com/Anvil/bash-argsparse @n
32-
#
31+
##
3332
## @par Purpose
34-
#
33+
##
3534
## To replace the option-parsing and usage-describing functions
3635
## commonly rewritten in all scripts.
3736
##
@@ -42,7 +41,7 @@
4241
## The extglob shell option will be enabled and posix mode will be
4342
## disabled when loading the library. Changing those settings
4443
## afterwards will make the library execution fail.
45-
#
44+
##
4645
## @par Usage
4746
## Use the argsparse_use_option() function to declare your options with
4847
## their single letter counterparts, along with their description.
@@ -72,7 +71,7 @@
7271
## What is referred later as "option" or "option name" (or even "long
7372
## option name") is the optstring without the ':' and '=' characters.
7473
##
75-
###
74+
##
7675
##
7776
## @par Options may have properties.
7877
##
@@ -171,7 +170,7 @@
171170
## argsparse_has_option_property() function.
172171
## @code argsparse_has_option_property <option> <property> @endcode
173172
##
174-
#
173+
##
175174
## @par Parsing positionnal parameters
176175
## After the options are declared, invoke the function
177176
## argsparse_parse_options() with the all script parameters. This will
@@ -201,7 +200,7 @@
201200
## e.g:
202201
## @code argsparse_is_option_set "long-option-name" @endcode
203202
##
204-
###
203+
##
205204
## @par The "usage()" function
206205
## If a 'usage' function is defined, and shall
207206
## argsparse_parse_options() return with non-zero status, 'usage' will
@@ -211,7 +210,7 @@
211210
## This library automatically defines a default 'usage' function,
212211
## which may be removed or overridden by the sourcing program
213212
## afterwards.
214-
#
213+
##
215214
##
216215
## @par Value setting internal logic
217216
## During option parsing, for every option of the form '--optionname'
@@ -248,7 +247,7 @@
248247
## All the functions will return with an error (usually a return code
249248
## of 1) if called with a wrong number of parameters, and return with
250249
## 0 if everything went fine.
251-
#
250+
##
252251
## @defgroup ArgsparseUsage Calling program usage description message.
253252
## @defgroup ArgsparseOptionSetter Setting options values.
254253
## @defgroup ArgsparseProperty Options properties handling.

0 commit comments

Comments
 (0)