On Thu, Jan 27, 2011 at 3:46 AM, éraj <[email protected]> wrote: > One more thing about the doc/api. I tried to run qdoc3 on the folder and it > failed. I don't have the error output but I could try it again and print it > out here. > I tried running on the latest master copy after failing on the 2.0.1 code > path, but that failed too. > So at the moment I'm with no API documentation for the Qt Creator. > Should I run qmake && make in doc/api or isnt qdoc3 good enuf ? Has anyone > had luck generating the entire api documentation for Qt Creator ? If you do > pls be kind enough to give instructions on how you did so. > > Eraj. > > On Mon, Jan 24, 2011 at 3:50 PM, <[email protected]> wrote: >> >> On Jan 24, 2011, at 5:55 AM, ext éraj wrote: >> >> > Hi, >> > I have downloaded the source package for version 2.0.1 of Qt Creator. I >> > was able to compile and run it. >> > However I find it difficult to understand the code without a proper hint >> > or direction of the architecture. >> > Can you guys help me with advice ? >> > It would be better if there were any material on the architecture of Qt >> > Creator or the design of the code. >> >> You can generate the little API doc we have by running qmake && make in >> doc/api (-->doc/api/html), and there is some very rough and unfinished thing >> about the plugin business about Qt Creator, without guaranteed correctness >> or usefulness in doc/pluginhowto >> >> -- >> Eike Ziller >> Software Engineer >> Nokia, Qt Development Frameworks >> >> Nokia gate5 GmbH >> Firmensitz: Invalidenstr. 117, 10115 Berlin, Germany >> Registergericht: Amtsgericht Charlottenburg, Berlin: HRB 106443 B >> Umsatzsteueridentifikationsnummer: DE 812 845 193 >> Geschäftsführer: Dr. Michael Halbherr, Karim Tähtivuori >> >> >> >> _______________________________________________ >> Qt-creator mailing list >> [email protected] >> http://lists.qt.nokia.com/mailman/listinfo/qt-creator > > > > -- > e's Mail - another one bites da dust !! > > _______________________________________________ > Qt-creator mailing list > [email protected] > http://lists.qt.nokia.com/mailman/listinfo/qt-creator > >
Hi Eraj, I really love the documentation that qdoc3[1] generates. Qt Documentation is one of the biggest reasons that attracted me to Qt a few years ago. Since then, of all the programming technologies I find Qt the most useful and friendly... even Python for that matter! Having said that to promote my advocacy for good documentation, for qt-creator at this point, cd into the doc/api directory and run 'doc3 qtcreator-api.docconf' to generate the api docs. The generated html docs will be generated into a folder labled 'html'. But, you might get an error saying that SRCDIR and possibly OUTDIR environment variables need to be defined. Then you can also generate Doxygen[2] documentation too, which gives better navigation and structure of the source code. What I do is use the 'doxywizard' app provided with Doxygen to throw in more 'bells and whistles' for the generated docs. So, run 'doxywizard' with the Doxyfile located in doc/doxygen folder and add some more configuration to it. Then run the Doxygen from 'doxywizard' and that should help you better navigate the sources. good luck, Peter [1] http://doc.qt.nokia.com/qdoc/index.html [2] http://www.stack.nl/~dimitri/doxygen/ _______________________________________________ Qt-creator mailing list [email protected] http://lists.qt.nokia.com/mailman/listinfo/qt-creator
