Uploaded image for project: 'Qt for Python'
  1. Qt for Python
  2. PYSIDE-1206

Investigate how to document the global functions available with a module

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • P2: Important
    • None
    • None
    • Documentation
    • None
    • DaVinci sprint 2

    Description

      Qt Core offers convenience headers such as, <QtMath>, <QtAlgorithm>, and so on, which offer a few functions. Some of the functionality offered by these headers are available with the module import in Python. For example, qAcos(), qAtan(), qAsin(), and many more.

      In Qt, such functionality is documented using qdoc's \headerfile command. But in Python, we don't need to include any additional  imports to access the functions. We should investigate how we can include the existing documentation for these functions in the Qt for Python documentation.

      Attachments

        Issue Links

          relates to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. PYSIDE-1112 Improve Qt for Python documentation

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-81709 Qdoc ignores \inmodule command for a function or enum

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. PYSIDE-1213 Extend the qtdoc generator to handle module pages generated by qdoc

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              veshivas Venugopal Shivashankar
              veshivas Venugopal Shivashankar
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes