doxygen and qt documentation
|
View:
New views
3 Messages
—
Rating Filter:
Alert me
|
 |
doxygen and qt documentation
by Lorenzo Bettini
::
Rate this Message:
Hi
I read that doxygen can produce qt documentation realted files (to be used in qt-assistant): Qt Help Project (.qhp) Generated if GENERATE_QHP is set to YES in the configuration file. The following output formats are indirectly supported by doxygen: Qt Compressed Help (.qch) Generated by Qt's qhelpgenerator tool from the HTML output if GENERATE_QHP is set to YES. but it's not clear to me how to get it done. I'd like to use it to produce, NOT api documentation, but a manual. For the moment I've been using qdoc3 an internal qt program, but they suggest to switch to doxygen (and qdoc files are basically doxygen syntax). any experience, code snippet, about this? many thanks in advance Lore -- Lorenzo Bettini, PhD in Computer Science, DI, Univ. Torino ICQ# lbetto, 16080134 (GNU/Linux User # 158233) HOME: http://www.lorenzobettini.it MUSIC: http://www.purplesucker.com http://www.myspace.com/supertrouperabba BLOGS: http://tronprog.blogspot.com http://longlivemusic.blogspot.com http://www.gnu.org/software/src-highlite http://www.gnu.org/software/gengetopt http://www.gnu.org/software/gengen http://doublecpp.sourceforge.net ------------------------------------------------------------------------------ Come build with us! The BlackBerry(R) Developer Conference in SF, CA is the only developer event you need to attend this year. Jumpstart your developing skills, take BlackBerry mobile applications to market and stay ahead of the curve. Join us from November 9 - 12, 2009. Register now! http://p.sf.net/sfu/devconference _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|
|
Re: doxygen and qt documentation
by Bugzilla from winter@kde.org
::
Rate this Message:
On Sunday 01 November 2009 6:30:38 am Lorenzo Bettini wrote:
> Hi > > I read that doxygen can produce qt documentation realted files (to be > used in qt-assistant): > > Qt Help Project (.qhp) > Generated if GENERATE_QHP is set to YES in the configuration file. > > The following output formats are indirectly supported by doxygen: > > Qt Compressed Help (.qch) > Generated by Qt's qhelpgenerator tool from the HTML output if > GENERATE_QHP is set to YES. > > but it's not clear to me how to get it done. > > I'd like to use it to produce, NOT api documentation, but a manual. For > the moment I've been using qdoc3 an internal qt program, but they > suggest to switch to doxygen (and qdoc files are basically doxygen syntax). > > any experience, code snippet, about this? > Obviously, you'll need to change QHP_NAMESPACE and QHP_VIRTUAL_FOLDER for your needs. GENERATE_QHP = YES QHP_NAMESPACE = org.kde.www QHP_VIRTUAL_FOLDER = KDE-4.3 QHG_LOCATION = qhelpgenerator make sure you have qhelpgenerator in your execute path. Not sure what you mean by "NOT api documentation, but a manual". ------------------------------------------------------------------------------ Come build with us! The BlackBerry(R) Developer Conference in SF, CA is the only developer event you need to attend this year. Jumpstart your developing skills, take BlackBerry mobile applications to market and stay ahead of the curve. Join us from November 9 - 12, 2009. Register now! http://p.sf.net/sfu/devconference _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|
|
Re: doxygen and qt documentation
by Lorenzo Bettini
::
Rate this Message:
Allen Winter wrote:
> On Sunday 01 November 2009 6:30:38 am Lorenzo Bettini wrote: >> Hi >> >> I read that doxygen can produce qt documentation realted files (to be >> used in qt-assistant): >> >> Qt Help Project (.qhp) >> Generated if GENERATE_QHP is set to YES in the configuration file. >> >> The following output formats are indirectly supported by doxygen: >> >> Qt Compressed Help (.qch) >> Generated by Qt's qhelpgenerator tool from the HTML output if >> GENERATE_QHP is set to YES. >> >> but it's not clear to me how to get it done. >> >> I'd like to use it to produce, NOT api documentation, but a manual. For >> the moment I've been using qdoc3 an internal qt program, but they >> suggest to switch to doxygen (and qdoc files are basically doxygen syntax). >> >> any experience, code snippet, about this? >> > I have the following lines in my Doxyfile to generate .qch file for KDE documention. > Obviously, you'll need to change QHP_NAMESPACE and QHP_VIRTUAL_FOLDER > for your needs. > > GENERATE_QHP = YES > QHP_NAMESPACE = org.kde.www > QHP_VIRTUAL_FOLDER = KDE-4.3 > QHG_LOCATION = qhelpgenerator > > make sure you have qhelpgenerator in your execute path. > Not sure what you mean by "NOT api documentation, but a manual". I mean the documentation of the application, the user manual :) do you also use a customized .css file? thanks Lorenzo -- Lorenzo Bettini, PhD in Computer Science, DI, Univ. Torino ICQ# lbetto, 16080134 (GNU/Linux User # 158233) HOME: http://www.lorenzobettini.it MUSIC: http://www.purplesucker.com http://www.myspace.com/supertrouperabba BLOGS: http://tronprog.blogspot.com http://longlivemusic.blogspot.com http://www.gnu.org/software/src-highlite http://www.gnu.org/software/gengetopt http://www.gnu.org/software/gengen http://doublecpp.sourceforge.net ------------------------------------------------------------------------------ Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day trial. Simplify your report design, integration and deployment - and focus on what you do best, core application coding. Discover what's new with Crystal Reports now. http://p.sf.net/sfu/bobj-july _______________________________________________ Doxygen-users mailing list Doxygen-users@... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
| Free embeddable forum powered by Nabble | Forum Help |
