Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-139658

QDoc: Restore showinternal functionality for internal documentation generation

XMLWordPrintable

    • Icon: User Story User Story
    • Resolution: Unresolved
    • Icon: P2: Important P2: Important
    • None
    • 6.11
    • Build tools: qdoc
    • DaVinci 124, DaVinci 125
    • 9557442d1 (dev), 77c651119 (dev), e60139313 (dev), f65a86aee (dev), 9ce85126a (dev), b05f93eda (dev), a99c2a26a (dev), 5a0705d57 (dev)

      QDoc includes a showinternal command line option and configuration variable designed to generate documentation for code marked with \internal commands. This feature worked in earlier versions but has degraded over time and is now non-functional, despite recent build system fixes (QTBUG-118176) that correctly pass the option to QDoc.

      With the recent implementation of private member documentation support, restoring showinternal functionality becomes even more valuable for generating comprehensive internal documentation that includes both private implementation details and internal APIs.

      Acceptance Criteria

      • showinternal command line option functions correctly
      • showinternal configuration variable works in .qdocconf files
      • Internal documentation (marked with \internal) appears in generated output when enabled
      • Feature works across all output formats (HTML, DocBook, WebXML)
      • Backward compatibility maintained - no documentation changes when showinternal is disabled
      • Test coverage includes validation of internal documentation generation

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

            paulwicking Paul Wicking
            paulwicking Paul Wicking
            Topi Reiniö Topi Reiniö
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: