From d282bc462578a6e47747c78d2d42883530f0d11e Mon Sep 17 00:00:00 2001 From: Mark Griffiths Date: Fri, 1 Aug 2014 03:37:32 +0100 Subject: Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. --- doc_src/funced.txt | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'doc_src/funced.txt') diff --git a/doc_src/funced.txt b/doc_src/funced.txt index 8b070b97..82f2cd63 100644 --- a/doc_src/funced.txt +++ b/doc_src/funced.txt @@ -1,21 +1,23 @@ \section funced funced - edit a function interactively \subsection funced-synopsis Synopsis - funced [OPTIONS] NAME +\fish{syn} +funced [OPTIONS] NAME +\endfish \subsection funced-description Description -\c funced provides an interface to edit the definition of the function -NAME. +`funced` provides an interface to edit the definition of the function +`NAME`. -If the \c $EDITOR environment variable is set, it will be used as the program +If the `$EDITOR` environment variable is set, it will be used as the program to edit the function. Otherwise, a built-in editor will be used. -If there is no function called \c NAME a new function will be created with +If there is no function called `NAME` a new function will be created with the specified name -- -e command or --editor command Open the function +- `-e command` or `--editor command` Open the function body inside the text editor given by the command (for example, "vi"). The command 'fish' will use the built-in editor. -- -i or --interactive Open function body in the +- `-i` or `--interactive` Open function body in the built-in editor. -- cgit v1.2.3