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

Qt Writing Guidelines: Update QDoc's Qt C++ and QML style guidelines

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • P3: Somewhat important
    • None
    • None
    • Documentation
    • framework-content 2

    Description

      The Qt Writing Guidelines needs an updated Qt C++ and QML style guidelines. The intent of these guidelines are to inform the Qt community how QDoc is to be used for documenting C++ and QML.

       

      -copy Qt Project related content from the QDoc Manual/Guide to the wiki, where the audience is for the Qt project users.

      -make the QDoc manual more neutral. QDoc manual is for any QDoc user, not just Qt Project.

      -work with safiyyah to prepare and edit the QDoc manual for the move.

       

      Reference:

      -QDoc Manual's guide content https://doc.qt.io/qt-6/qdoc-guide.html

      -Qt Writing Guidelines: https://wiki.qt.io/Qt_Writing_Guidelines

      Attachments

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

        Activity

          People

            jerome.pasion Jerome Pasion
            jerome.pasion Jerome Pasion
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes