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

Control over which page a namespaced function appears in

    XMLWordPrintable

Details

    • 16239de72 (dev)
    • DaVinci 107

    Description

      Consider the following project

      foo.h

      /*!
       * \namespace Foo
       * A namespace
       * \inmodule Foo
       */
      namespace Foo {
          /*!
           * does stuff
           */
          void doStuff();
      } 

      bar.h

      namespace Foo {
          /*!
           * \class Foo::Bar
           * \inmodule Foo
           */
          class Bar {
          };
      
          /*!
           * Create a Bar
           */
          Bar createBar();
      } 

      foo.qdoc

      /*!
          \module Foo
          \title Foo C++ Classes
          \brief Stuff.
      */ 

      foo.qdocconf

      project = Foo
      description = Stuff
      documentationinheaders = true
      headerdirs = .
      sourcedirs = . 

       

      This will create two main pages, foo.html and bar.html

      foo.html will show the namespace and the two functions doSomething() and createBar(). It also says to #include <Foo> to use createBar().

      However createBar actually needs #include <Bar>, and it much more closely associated with the Bar class. Therefore I want it to be part of bar.html instead.

      To achieve that I tried to add "\relates Foo::Bar" to createBar(), but that doesn't change anything. And neither does "\inheaderfile Bar"

       

      Attachments

        For Gerrit Dashboard: QTBUG-130674
        # Subject Branch Project Status CR V

        Activity

          People

            treinio Topi Reiniö
            nicolasfella Nicolas Fella
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There is 1 open Gerrit change