Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. Qt Creator and other tools
  4. Create context Help when mouse pointer is on a text when coding
Forum Update on Monday, May 27th 2025

Create context Help when mouse pointer is on a text when coding

Scheduled Pinned Locked Moved Unsolved Qt Creator and other tools
4 Posts 2 Posters 302 Views
  • 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.
  • N Offline
    N Offline
    ntdungk55
    wrote on last edited by
    #1

    Hello everyone ,
    i got stuck when i want to create a help documentation for my
    code to guide users can use my library properly .
    My question as title and i look forward any help soon.
    Thank you in advance and forgive my english ability limitation.

    1 Reply Last reply
    0
    • sierdzioS Offline
      sierdzioS Offline
      sierdzio
      Moderators
      wrote on last edited by
      #2

      First: document your code. This will allow Qt Creator (is that your IDE?) to recognize documentation comments and will display them on hover automatically.

      If you want to install documentation like Qt has it (F1 takes you to full class documentation), you need to generate .qch help file from your project, then manually install it to Qt Creator.

      A good documentation tool which will help you do all that is doxygen.

      (Z(:^

      N 1 Reply Last reply
      3
      • sierdzioS sierdzio

        First: document your code. This will allow Qt Creator (is that your IDE?) to recognize documentation comments and will display them on hover automatically.

        If you want to install documentation like Qt has it (F1 takes you to full class documentation), you need to generate .qch help file from your project, then manually install it to Qt Creator.

        A good documentation tool which will help you do all that is doxygen.

        N Offline
        N Offline
        ntdungk55
        wrote on last edited by
        #3

        @sierdzio Thank you very much .
        However , I dont find any instruction for creating .qch file by
        doxygen . please give me any instruction .

        1 Reply Last reply
        0
        • sierdzioS Offline
          sierdzioS Offline
          sierdzio
          Moderators
          wrote on last edited by
          #4

          Here is the documentation entry for .qch generation in doxygen: http://doxygen.nl/manual/config.html#cfg_qch_file

          (Z(:^

          1 Reply Last reply
          3

          • Login

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