Re: @ref into @seealso

[John W. Eaton]

On 21-Oct-2008, Søren Hauberg wrote:

| The munge-texi program essentially replaces all @DOCSTRING(func) with
| the texinfo help text of 'func', right? When reading the help text of
| 'func', we would then have to search for @seealso, and handle those
| appropriately. I guess it wouldn't be to hard to do, but I think it
| would be better to rewrite munge-texi as an m-file.

OK, that would be fine too.  I was thinking that munge-texi also
expanded the C++ language escape sequences in the docstrings that are
embedded in the C++ source files, and so would be easiest to handle
with a C++ program.  But that is handled when the DOCSTRING files are
created.  So if you would prefer to handle this in a .m file, that
would be good.  Either way, I think the transformations should be
handled in one program rather than several.

| Some weeks ago I posted a suggestion on rewriting the help system as
| m-files [1]. This approach included the function 'get_help_text' which
| returns the raw texinfo help string of a function (using the code
| already in Octave for this). Using this function, it would be trivial to
| rewrite munge-texi as an m-file, which in turn would make it easier to
| change munge-texi to expand @seealso.

OK.  I think it would be good to move this part of Octave to .m files
if possible.  Sorry for not responding to your earlier message, but as
more people are contributing it's unlikely that I can comment on every
proposal (which is why I'm glad to see you commenting on Thorsten's
proposal).

jwe