Skip to content

Commit 7f0c2ce

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

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

argsparse-completion.sh

Lines changed: 14 additions & 15 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 completion for scripts using argsparse library.
7-
## @copyright WTFPLv2
8-
## @version 1.8
9-
#
104
#########
115
# License:
126
#
@@ -26,29 +20,34 @@
2620
#
2721
#########
2822
#
23+
## @file
24+
## @author Damien Nadé <bash-argsparse@livna.org>
25+
## @brief Bash completion for scripts using argsparse library.
26+
## @copyright WTFPLv2
27+
## @version 1.8
2928
## @details
3029
## @par URL
3130
## https://github.com/Anvil/bash-argsparse @n
32-
#
31+
##
3332
## @par Purpose
34-
#
33+
##
3534
## To automatically enable, for bash-completion users, completion for
3635
## scripts that use the argsparse library.
37-
36+
##
3837
## @par Usage
39-
#
38+
##
4039
## In your ~/.bashrc, add the following lines to enable completion for
4140
## all your argsparse-written scripts:
4241
##
4342
## @code
4443
## . argsparse-completion.sh
4544
## complete -F _argsparse_complete [ your scripts names ... ]
4645
## @endcode
47-
#
46+
##
4847
## @par Required configuration
49-
#
48+
##
5049
## argsparse-completion relies on a few shell settings:
51-
#
50+
##
5251
## @li "sourcepath" shell option must be enabled. This should be
5352
## enabled by default, but you can enforce it by running:
5453
##
@@ -65,7 +64,7 @@
6564
## @endcode
6665
##
6766
## @par Limitations
68-
#
67+
##
6968
## @li Every time the completion is invoked, the completed script will
7069
## be sourced, up to either the argsparse_parse_options() function
7170
## call or any the first return top-level statement. This means that
@@ -77,7 +76,7 @@
7776
## implemented.
7877
##
7978
##
80-
#
79+
##
8180
## @defgroup ArgsparseCompletion Bash Completion-related functions.
8281

8382
## @fn __argsparse_compgen()

0 commit comments

Comments
 (0)