• Top
    • Documentation
      • Xdoc
        • Undocumented
        • Save
        • Defsection
        • Markup
        • Preprocessor
        • Emacs-links
        • Defxdoc
        • Katex-integration
        • Constructors
        • Entities
        • Save-rendered
        • Add-resource-directory
        • Defxdoc+
        • Testing
        • Order-subtopics
        • Save-rendered-event
        • Archive-matching-topics
        • Missing-parents
        • Archive-xdoc
        • Xdoc-extend
        • Set-default-parents
        • Defpointer
        • Defxdoc-raw
        • Xdoc-tests
        • Xdoc-prepend
        • Defsection-progn
        • Gen-xdoc-for-file
        • ACL2-doc
        • Pointers
        • Doc
        • Documentation-copyright
        • Args
        • ACL2-doc-summary
        • Finding-documentation
        • Broken-link
      • Books
      • Recursion-and-induction
      • Boolean-reasoning
      • Projects
      • Debugging
      • Std
      • Proof-automation
      • Macro-libraries
      • ACL2
      • Interfacing-tools
      • Hardware-verification
      • Software-verification
      • Testing-utilities
      • Math
    • Xdoc

    Gen-xdoc-for-file

    Generate xdoc using textual definitions from a .lisp file.

    ;; Generate xdoc topics for the given ITEMS, each of which is a doublet of a
    ;; name and its :short xdoc string.  The body of each generated xdoc topic will
    ;; contain the block of lines (demarcated by empty lines) from the given
    ;; FILENAME that defines the given name.  Each name must be defined in a defun,
    ;; defund, defmacro, defthm, defthmd, or define.
    (defmacro gen-xdoc-for-file (filename
                                 items
                                 parents)
      `(make-event (gen-xdoc-for-file-fn ',filename ',items ',parents state)))