Version: 3.5.2 (using 3.5.9, Kubuntu (hardy) 4:3.5.9-0ubuntu7.1) Compiler: Target: i486-linux-gnu OS: Linux (i686) release 2.6.24-19-generic The documentation browser of KDevelop3 (newest stable version of kdevelop.org) is in MANY cases useless or outdated. Look through the documentation list. Many are broken: -Rails, -QtRuby -"Qt-Designer-3 and KDevelop-3" -Python -PHP -LIBC -"Qt Assistant Manual" -"Guide to the Qt Translation tools" Some are outdated: -"Gnome 1.0 API Reference" which in real links correctly to 2.x Reference, -"KDE2 Development Book (kde.org)" documentation - who needs that? Some completely missing (ok, needs volunteer work...) -Qt4 Documentation? (ok , there is "Qt Reference Documentation" but: qt3? qt4?) -KDE4 (there is "The KDE API Reference" for 3.5.9 - but KDE 4? ok, KDE3 is deprecated you should program for KDE4. But how? Using KDevelop4 which is unstable?) I am speakin a as a beginner. I know if you can program Qt4 (or Ruby,PHP,Python etc) perfectly you have no need for all this. But I know that programmers often forget how people feel who want to start - it's a different view angle. I would like to help you updating the documentation - just tell my how. Editing the .toc files manually is no option. I've contacted the PHP and Python doc guys, they will provide new .toc files. look at https://bugs.launchpad.net/ubuntu/+source/kdevelop/+bug/249462 https://bugs.launchpad.net/ubuntu/+source/kdevelop/+bug/249563 But there are all the other broken links too.
You can patch the files and send us the results. The sources are in doc/ and in languages/*/doc/ (each programming language has it's own directory)
Yes, i know - but, as I said - manually editing the files is no option for me - and for nobody else neither. The php.toc file e.g. has >1600 lines xml code. You can edit it manually and check all the links (in 5-6 weeks or so) or let it do a parser (in 2 seconds). I just wanted to ask how you created these files - I don't believe you wrote them manually ;-)
Most of the files are less than 5 lines of code and only contain a single link. If you could fix those it would be very good. Please keep in mind that some of them point to localy installed docs, but we do not want to force every user to install the docs to every single one of the twelve supported languages, so the dependencies are not forced by the rpm/deb systems. But if the documentation is (manually) installed it will show up. So please do not break those. Basically: try to add on-line docs (http:) without removing off-line docs (/usr/doc) Thanks. PS. regarding the php toc file I have no clue how it was generated. Take a look at SVN history for info. websvn.kde.org/branches/KDE/3.5/kdevelop/languages/php/doc/
Ok. I am in contact with the PHP and Python doc guys as I said, and will provide patches/new .toc files And I'll have a look at some of the the others too ;-)
They just answered me, here the cites: ------------------------------------- Hi! I just wrote a Kdevelop output for PhD, here is an updated version of the PHP kdevelop toc : iutinfoa1.free.fr/SoC/php.toc. When it will be out-to-date, you\'ll need to use PhD (our new documentation build system) to generate another one (with up-to-date phpdoc). If you need information about using PhD to generate updated kdevelop toc, please contact me or Hannes Magnusson CCed or go to http://wiki.php.net/doc/phd (basically, you\'ll need to fetch PhD and an updated version of phpdoc via the PHP CVS repository and use the modifier \'-t phpkdevelop\'). Regards Rudy Nappée ------------------------------------- We should probably make it available from php.net, and throw it into the regular builds so it'll get updated whenever needed. The various distros, and upstream, can then fetch the latest file before packaging kdevelop... -Hannes
Created attachment 26314 [details] new php.toc file I'll wait until the python .toc is ready and post it here - we can close this bug afterwords IMO.
KDevelop 3.5.3 release is planned for 17 Aug 2008 If the patch is ready before that date it can be integrated....
The php doc is attached, the python guys don't answer. I wrote a patch to update the documentation. http://launchpadlibrarian.net/16133616/new_python_URL.patch It is far from perfect (tere are still some chapters not working), but at least it is usable - the current version is completely broken - if you want you can include it.
used the wrong keyword. I've comitted that yesterday in revision 848077