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

Allow the \include qdoc command to include a snippet from a .qdocinc file instead of always including the entire file.

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • P2: Important
    • 4.7.4
    • None
    • Documentation
    • 131f429e43a5c382ae208af39bc5f889c39dee8

    Description

      The \include qdoc command allows you to include a sequence of qdoc commands and text in the input stream to qdoc. This command is useful when you want to include a documentation snippet in multiple places in the documentation output. The command was limited in that it only allowed you to include an entire .qdocinc file in the input stream.

      The command format has been altered to allow a second argument, e.g. \include <file-path> <snippet-name>, where <snippet-name> names a block of qdoc commands and text in the file identified by <file-path>. The block of qdoc commands and text is surrounded by:

      //! [<snippet-name>]

      ...commands and text...

      //! [<snippet-name>]

      Attachments

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

        Activity

          People

            gbk Martin Smith (Qt)
            gbk Martin Smith (Qt)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes