Mercurial > jwe > octave

changeset 23855:f9498eb0bbc1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
import.m: Update docstring. * import.m: Use @deftypefnx correctly to stop warning from makeinfo. Use @group around multiple lines in @example block. Strip trailing whitespace.
author Rik <rik@octave.org>
date Wed, 09 Aug 2017 15:56:29 -0700
parents aa0c6708046a
children 41a0b750c36e
files scripts/path/import.m
diffstat 1 files changed, 9 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/path/import.m	Wed Aug 09 11:31:10 2017 -0700
+++ b/scripts/path/import.m	Wed Aug 09 15:56:29 2017 -0700
@@ -17,11 +17,11 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {} {} import PACKAGE.FUNCTION
-## @deftypefn {} {} import PACKAGE.CLASS
-## @deftypefn {} {} import PACKAGE.*
-## @deftypefn {} {} import
-## @deftypefn {} {@var{list} =} import
+## @deftypefn  {} {} import PACKAGE.FUNCTION
+## @deftypefnx {} {} import PACKAGE.CLASS
+## @deftypefnx {} {} import PACKAGE.*
+## @deftypefnx {} {} import
+## @deftypefnx {} {@var{list} =} import
 ##
 ## Import function or classes into the current scope.
 ##
@@ -36,16 +36,18 @@
 ## Example
 ##
 ## @example
+## @group
 ## import containers.Map;
 ##
 ## m = Map ({"A", "B"}, {[1], [2]});
+## @end group
 ## @end example
 ##
-## When called with no inputs and no outputs @code{import} prints a list of 
+## When called with no inputs and no outputs @code{import} prints a list of
 ## any import definitions.
 ##
 ## When called with no inputs and one output, a cell array of strings
-## @var{list} is returned with any import definitions. 
+## @var{list} is returned with any import definitions.
 ##
 ## @end deftypefn