• Top
  • Documentation
    • Xdoc
      • Undocumented
      • Save
      • Defsection
      • Markup
      • Preprocessor
      • Terminal
      • Emacs-links
      • Entities
      • Defxdoc
      • Katex-integration
      • Constructors
        • Primitive-constructors
        • Composite-constructors
          • Xdoc::apt-constructors
            • Xdoc::desc-apt-input-thm-name
            • Xdoc::desc-apt-input-thm-enable
            • Xdoc::desc-apt-input-verify-guards
            • Xdoc::apt-design-notes-ref
            • Xdoc::desc-apt-input-wrapper-to-old-name
            • Xdoc::desc-apt-input-old-to-wrapper-name
            • Xdoc::desc-apt-input-wrapper-to-old-enable
            • Xdoc::desc-apt-input-wrapper-name
            • Xdoc::desc-apt-input-old-to-wrapper-enable
            • Xdoc::desc-apt-input-old-to-new-name
            • Xdoc::desc-apt-input-old-if-new-name
            • Xdoc::desc-apt-input-new-to-old-name
            • Xdoc::desc-apt-input-wrapper-enable
            • Xdoc::desc-apt-input-old-to-new-enable
            • Xdoc::desc-apt-input-old-if-new-enable
            • Xdoc::desc-apt-input-new-to-old-enable
            • Xdoc::desc-apt-input-new-name
            • Xdoc::desc-apt-input-untranslate
            • Xdoc::desc-apt-input-old
            • Xdoc::desc-apt-input-new-enable
            • Xdoc::desc-apt-input-wrapper
          • Generic-composite-constructors
          • Event-macro-xdoc-constructors
        • 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

• Xdoc::apt-constructors

Xdoc::desc-apt-input-wrapper-enable

Build a description of the :wrapper-enable input for the user documentation of an APT transformation.

Macro: desc-apt-input-wrapper-enable

(defmacro xdoc::desc-apt-input-wrapper-enable (&rest additional)
 (cons
  'xdoc::desc
  (cons
   '"@(':wrapper-enable') —
     default from <see topic='@(url defaults-table)'>table</see>"
   (cons
    '(xdoc::p "Determines whether the wrapper function is enabled.")
    (cons
     '(xdoc::p "It must be one of the following:")
     (cons
      '(xdoc::ul
        (xdoc::li "@('t'), to enable it.")
        (xdoc::li "@('nil'), to disable it.")
        (xdoc::li
         "Absent, to use the value from the APT defaults table,
       which is set via @(tsee set-default-input-wrapper-enable)."))
      (cons
       '(xdoc::p
         "This input may be present only if the @(':wrapper') input is @('t').")
       additional)))))))