Mercurial > hg > octave-nkf

comparison scripts/path/__extractpath__.m @ 8812:7d48766c21a5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
use consistent format for doc strings of internal functions
author John W. Eaton <jwe@octave.org>
date Thu, 19 Feb 2009 02:16:34 -0500
parents 3422f39573b1
children eb63fbe60fab
comparison
equal deleted inserted replaced
8811:20dfb885f877 8812:7d48766c21a5
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {@var{val} =} __extractpath__ (@var{file}) 21 ## @deftypefn {Function File} {@var{val} =} __extractpath__ (@var{file})
22 ## Undocumented internal function.
23 ## @end deftypefn
24
22 ## Extact the path information from the script/function @var{file}, 25 ## Extact the path information from the script/function @var{file},
23 ## created by @file{savepath.m}. If @var{file} is omitted, 26 ## created by @file{savepath.m}. If @var{file} is omitted,
24 ## @file{~/.octaverc} is used. If successful, @code{__extractpath__} 27 ## @file{~/.octaverc} is used. If successful, @code{__extractpath__}
25 ## returns the path specified in @var{file}. 28 ## returns the path specified in @var{file}.
26 ## @seealso{path, addpath, rmpath, genpath, pathdef, savepath, pathsep}
27 ## @end deftypefn
28 29
29 ## Author: Ben Abbott <bpabbott@mac.com> 30 ## Author: Ben Abbott <bpabbott@mac.com>
30 31
31 function specifiedpath = __extractpath__ (savefile) 32 function specifiedpath = __extractpath__ (savefile)
32 33