Results 1 to 3 of 3

Thread: Easier access to Qt Documentation

Threaded View

Previous Post Previous Post   Next Post Next Post
  1. #1
    Join Date
    Jan 2006
    Location
    Knivsta, Sweden
    Posts
    153
    Qt products
    Qt4 Qt5
    Platforms
    Unix/X11
    Thanks
    30
    Thanked 13 Times in 12 Posts

    Default Easier access to Qt Documentation

    Here is the itch I had to scratch: When coding in Qt, it takes a lot of scrolling and time to find the right classes on the All Classes page. There is of course the Main Classes page, but you might not agree with the Trolls on which classes are the "main" ones.

    With this short program it is easy to make a small & relevant page:

    1. The program takes one argument, the name of a directory where you keep source code for some big project.
    2. In that directory, all files with extention .cc .h and .cpp will be scanned for Qt classes.
    3. On stdout, the program will print a html page formatted just like Main Classes but with your classes instead.
    4. So direct the output to a file, say myclasses.html, in <Qt-installation-dir>/doc/html.
    5. edit <Qt-installation-dir>/doc/html/index.html Right after the first "middot", insert something like:
      Qt Code:
      1. <a href="myclasses.html"><font color="#004faf">Foobar's&nbsp;Classes</font></a>&nbsp;&middot;
      To copy to clipboard, switch view to plain text mode 
    6. Then, you can browse the docs with Qt Assistant or a web browser, as usual.


    (Tested on Linux)
    Attached Files Attached Files

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
Qt is a trademark of The Qt Company.