• Top
    • Documentation
      • Xdoc
        • Undocumented
        • Save
        • Defsection
        • Markup
        • Preprocessor
        • Terminal
        • Emacs-links
        • Entities
        • Defxdoc
        • Katex-integration
        • Constructors
          • Primitive-constructors
          • Composite-constructors
            • Xdoc::apt-constructors
            • Generic-composite-constructors
            • Event-macro-xdoc-constructors
              • Event-macro-xdoc-constructors-user-level
              • Event-macro-xdoc-constructors-implementation-level
                • Xdoc::evmac-topic-implementation
                • Xdoc::evmac-topic-event-generation
                • Xdoc::evmac-topic-input-processing
                • Xdoc::evmac-topic-library-extensions
            • Constructor-preliminaries
            • Trees
          • Defxdoc+
          • Save-rendered
          • Add-resource-directory
          • Testing
          • Order-subtopics
          • Save-rendered-event
          • Archive-matching-topics
          • Archive-xdoc
          • Xdoc-extend
          • Set-default-parents
          • Missing-parents
          • Defpointer
          • Defxdoc-raw
          • Xdoc-tests
          • Xdoc-prepend
          • Defsection-progn
          • Gen-xdoc-for-file
        • ACL2-doc
        • Recursion-and-induction
        • Loop$-primer
        • Operational-semantics
        • Pointers
        • Doc
        • Documentation-copyright
        • Publications
        • Course-materials
        • Args
        • ACL2-doc-summary
        • Finding-documentation
        • Broken-link
        • Doc-terminal-test-2
        • Doc-terminal-test-1
      • Books
      • Boolean-reasoning
      • Projects
      • Debugging
      • Community
      • Std
      • Proof-automation
      • Macro-libraries
      • ACL2
      • Interfacing-tools
      • Hardware-verification
      • Software-verification
      • Math
      • Testing-utilities
    • Event-macro-xdoc-constructors-implementation-level

    Xdoc::evmac-topic-library-extensions

    Generate an XDOC topic for the library extensions that are part of the implementation of an event macro.

    Macro: evmac-topic-library-extensions

    (defmacro xdoc::evmac-topic-library-extensions (macro)
     (declare (xargs :guard (symbolp macro)))
     (b*
      ((macro-name (string-downcase (symbol-name macro)))
       (macro-ref (concatenate 'string
                               "@(tsee " macro-name ")"))
       (this-topic (add-suffix macro "-LIBRARY-EXTENSIONS"))
       (parent-topic (add-suffix macro "-IMPLEMENTATION"))
       (short (concatenate 'string
                           "Library extensions for "
                           macro-ref "."))
       (long
        (xdoc::topstring-p
         "These are used by, but more general than, "
         macro-ref
         ". Thus, they should be moved
                     to more general libraries eventually.")))
      (cons
       'defxdoc+
       (cons
        this-topic
        (cons
         ':parents
         (cons
          (cons parent-topic 'nil)
          (cons
           ':short
           (cons
             short
             (cons ':long
                   (cons long
                         '(:order-subtopics t
                                            :default-parent t)))))))))))