Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. General and Desktop
  4. Is there a way to create documentation using QDoc for global functions?
Forum Updated to NodeBB v4.3 + New Features

Is there a way to create documentation using QDoc for global functions?

Scheduled Pinned Locked Moved Solved General and Desktop
3 Posts 3 Posters 157 Views 1 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • Y Offline
    Y Offline
    ynakane
    wrote on last edited by ynakane
    #1

    Hi.

    I am using QDoc to document my project.
    For class functions, I was able to document them using the \fn command.
    However, even if I wrote a same command in the global function, it was not output to html.
    Is there any way to document global functions?
    For example, for the main function in main.cpp

    Or is this possible using Doxygen instead of QDoc?

    Thanks for your help.

    sierdzioS 1 Reply Last reply
    0
    • Y ynakane

      Hi.

      I am using QDoc to document my project.
      For class functions, I was able to document them using the \fn command.
      However, even if I wrote a same command in the global function, it was not output to html.
      Is there any way to document global functions?
      For example, for the main function in main.cpp

      Or is this possible using Doxygen instead of QDoc?

      Thanks for your help.

      sierdzioS Offline
      sierdzioS Offline
      sierdzio
      Moderators
      wrote on last edited by
      #2

      @ynakane said in Is there a way to create documentation using QDoc for global functions?:

      Or is this possible using Doxygen instead of QDoc?

      Not only possible but recommended. QDoc is an internal tool used only to document Qt itself. For all other code, use Doxygen.

      (Z(:^

      1 Reply Last reply
      0
      • A Offline
        A Offline
        aliks-os
        wrote on last edited by
        #3

        @ynakane said in Is there a way to create documentation using QDoc for global functions?:

        For example, for the main function in main.cpp

        main.cpp is not normally used for any functions that need to be documented. Create the class for any functionality and then use QDoc commands for documentation.

        1 Reply Last reply
        0

        • Login

        • Login or register to search.
        • First post
          Last post
        0
        • Categories
        • Recent
        • Tags
        • Popular
        • Users
        • Groups
        • Search
        • Get Qt Extensions
        • Unsolved