RE: [External] : Re: Documentation about elisp code

[Drew Adams]

> Is there a way to call the documentation of another defun from the
> in the doc-string using some sort of link?

Yes.  Just do the following in your doc string:

1. Put the function or command (or variable or option)
   name between ` and ' in your doc string.  E.g.,
   `foobar'.

2. Put the word "function" or "command" (or "variable"
   or "option") immediately before the text of #1 in
   your doc string.  E.g., "...function `foobar'...".

Example:

(defun tata ()
  "This is tata.
And here is a link to function `forward-char'."
  42)

Programmatically, the link is created by a function
such as `help-insert-xref-button', to which you pass
the link-text string and a button type (and possibly
other args).  You can create a new button type using
macro `define-button-type'.

For the definition of `help-insert-xref-button',
examples of its use, and examples of defining button
types, see standard library `help-mode.el'.