octave-maintainers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Finding DOCSTRINGS in the source code


From: Rik
Subject: Re: Finding DOCSTRINGS in the source code
Date: Sun, 16 Jan 2011 07:58:21 -0800

> 
> I noticed Attr flags in a whos command that are not in the help whos
> documentation.  Since whos is builtin I do not know where the documentation
> is kept.  
'whos' is documented in src/variables.cc.  There may be a better way to do
it, but I use the following to find where the Texinfo strings are kept.

cd doc/interpreter
grep 'DOCSTRING(whos)' *.txi
--> var.texi
grep -B 4 'deftypefn .*\<whos\>' var.texi
-->


@c src/variables.cc
@anchor{doc-whos}
@deftypefn  {Command} {} whos

Every function has an @c comment indicating where the Texinfo string came
from.  If you already know that it came from a script or the src directory
then you can skip the first grep.  Instead you can use the second grep on
'scripts/DOCSTRINGS' or 'src/DOCSTRINGS'.

--Rik


reply via email to

[Prev in Thread] Current Thread [Next in Thread]