Results 1 to 4 of 4

Thread: Documenting for QTextBrowser

  1. #1
    Join Date
    Jan 2006
    Posts
    369
    Thanks
    14
    Thanked 18 Times in 17 Posts
    Qt products
    Qt4
    Platforms
    Unix/X11 Windows

    Thumbs up Documenting for QTextBrowser

    I remember some time ago a few folks were asking about the documentation tool to be used for Qt4 applications. While doxygen kicks ass, QTextBrowser cannot handle those files (since they include refernces to external css files).

    I found out this nice little tool called asciidoc (http://www.methods.co.nz/asciidoc/) which can be used for documentation. The HTML created by that tool is QTextBrowser friendly, and the input is a simple text file. See the online site for examples (the main page is written using asciidoc, pretty cool IMHO).
    Last edited by elcuco; 8th July 2007 at 18:46. Reason: spelling error

  2. #2
    Join Date
    Jan 2006
    Location
    Warsaw, Poland
    Posts
    33,359
    Thanks
    3
    Thanked 5,015 Times in 4,792 Posts
    Qt products
    Qt3 Qt4 Qt5 Qt/Embedded
    Platforms
    Unix/X11 Windows Android Maemo/MeeGo
    Wiki edits
    10

    Default Re: Documenting for QTextBrowser

    I use doxygen + a xslt processor for generating nice html files.

  3. #3
    Join Date
    Jan 2006
    Posts
    369
    Thanks
    14
    Thanked 18 Times in 17 Posts
    Qt products
    Qt4
    Platforms
    Unix/X11 Windows

    Default Re: Documenting for QTextBrowser

    ...? can you explain?

    I think that a simple perl magic would "inline" the css in to the HTML and thus make it more QTextBrowser friendly.

    Can you share the XSLT commands...?

  4. #4
    Join Date
    Jan 2006
    Location
    Warsaw, Poland
    Posts
    33,359
    Thanks
    3
    Thanked 5,015 Times in 4,792 Posts
    Qt products
    Qt3 Qt4 Qt5 Qt/Embedded
    Platforms
    Unix/X11 Windows Android Maemo/MeeGo
    Wiki edits
    10

    Default Re: Documenting for QTextBrowser

    Quote Originally Posted by elcuco View Post
    I think that a simple perl magic would "inline" the css in to the HTML and thus make it more QTextBrowser friendly.
    I want the output to look different from what Doxygen generates. A snippet attached.

    Can you share the XSLT commands...?
    I'll think of that when it's mature enough
    Attached Files Attached Files

Similar Threads

  1. Documenting a Qt Application
    By dvmorris in forum Qt Programming
    Replies: 6
    Last Post: 24th June 2007, 17:24

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
  •  
Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide.