		Search-engine friendly clone of the ACL2 documentation.

Xdoc

Xdoc-prepend

Extend an existing XDOC topic with additional content, at the front.

(xdoc-prepend name long) is very much like xdoc-extend, except that it extends the :long string for name at the front, instead of at the back.

Basic example:

(defxdoc foo
  :short "Example of xdoc-prepend."
  :long "<p>Foo is very important.</p>")

(xdoc::xdoc-prepend foo
  "<p>Never use Foo, use Bar instead!</p>")

is roughly equivalent to just writing:

(defxdoc foo
  :short "Example of xdoc-prepend."
  :long "<p>Never use Foo, use Bar instead!</p>
          <p>Foo is very important.</p>")

See xdoc-extend for related commentary.