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

navibar: allow multiple \annotatedlist in a single .qdoc file

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Invalid
    • Icon: P4: Low P4: Low
    • None
    • 6.7
    • Build tools: qdoc
    • None
    • Linux/X11, Windows

      If I have an \annotatedlist groupName in one page, and then I have a bunch of other pages generated that are \ingroup groupName, I expect the "up" link (the rightmost link in the generated navigation bar) of a given \ingroup groupName page to go to the section/page that contains the \annotatedlist groupName.

      Currently, that is true only if groupName is the same as the \group groupName in that .qdoc file. So as far as the navibar is concerned, a .qdoc file can have only 1 \annotatedlist. 

      If the names do not match, the navibar of each page \ingroup groupName is broken. 

      My use case is that I want to have multiple annotated lists for different groups of functions, for the squish-api.qdoc 

      The workaround I plan to use is to set the \previouspage to point to the parent document instead of worrying about the generated navigation bar. 

      The existence of an \annotatedlist groupName where groupName is not the same as the \group  parentGroup of the same .qdoc file, qdoc should implicitly define a new group with that name, and get a title from the \sectionX header it is found in (or require another \title line?). There should be a child-parent link between groupName and parentGroup so that they both appear in the navibar of the generated \ingroup groupName pages as parent/grandparent. 

       

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

            docinfrastructure Documentation Infrastructure Team
            ezust alan ezust
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes