• TOC
  • Testing QDoc output from .qdoc files
  • OutputFromQDocFiles - A test project for QDoc build artifacts
  • Testing QDoc output from .qdoc files

    QDoc generates documentation for software projects. It does this by extracting QDoc comments from project source files. QDoc comments are signified by a C-style-like comment tag followed by an exclamation point, like this: /*! This text is contained within QDoc comment tags. */.

    Supported file types

    QDoc parses .cpp and .qdoc files. It does extract comments from header (.h) files.

    Further information

    This test document is written with the purpose of testing the output QDoc generates when parsing .qdoc files. It is fairly simple and makes use of a limited subset of QDoc's command. Those commands are:

    Linking

    There are multiple ways to create hyperlinks to other topics:

    QDoc Linking Test

    This section title is overridden by another target which takes precedence.

    Linking to something in a section title

    This is allowed but a questionable practice.

    QDoc details

    Note: You're looking at detailed information.