Re: Documentation from elisp files

Re: Documentation from elisp files

[Lowell Gilbert]

Michael Powe <michael+gnus@trollope.org> writes:

> Hello,
>
> I was working with a mode recently and could not make it do what I
> wanted to do.  While researching, I found that, in fact, the
> functionality was there but undocumented -- except in the .el file
> itself. 
>
> This makes me ask the question, How could I extract from the .el the
> functions, variables and their doc strings? I could create a "help" file
> and forward it to the mode authors.  It would certainly save me time in
> the future and contribute to the usability of the mode.
>
> Is there already a tool for doing such an extraction?

The functions, variables and doc strings pretty much *is* the source
file.  It's not clear what you want; maybe sidebar would give you a
browsing capability you're looking for?  Or forward-paragraph?

Ultimately, I think there's no way around reading the source if you 
want to document it better.

Re: Documentation from elisp files

[Michael Powe]

>>>>> "José" == José A Romero L <escherdragon@gmail.com> writes:

    José> On Oct 18, 1:31 pm, Michael Powe <michael+g...@trollope.org> wrote:
    José> (...)
    >> This makes me ask the question, How could I extract from the .el
    >> the functions, variables and their doc strings? I could create a
    >> "help" file
    José> (...)

    José> Is it C-h f and C-h v (or M-x describe-function and M-x
    José> describe-variable) what you're looking for?

Hello,

The output of those requests is useful but if you don't know what you
are looking for, you have to tab through everything individually to see
what they do.

I was thinking more in terms of creating a 'help file,' like the
documentation I can create for a Java library via Javadoc.

Thanks.

mp

-- 
cat: /home/powem/.signature: No such file or directory