TheBlindCow

28 February 2009

KDevelop4’s Documentation Integration

Filed under: KDE,KDevelop,my projects,Software Libre — apol @ 5:59 pm

I’m back to you today to show something that we have been baking lately for KDevelop. It is its new documentation integration.

With KDevelop 4 we have been focusing on putting together the information that the user will be willing to read every moment. Until now, while browsing the code, we were only showing the information gathered by the C++ support. Since the last week this is no longer true, we can now show the documentation provided by the different documentation plugins. We only have a QtHelp plugin for now, but I hope the architecture will be flexible enough for the new plugins we will have on the future, such as, maybe, a Doxygen’s, cmake’s or anything the reader can imagine.

Here you can see a couple of screenshots that might give you an idea of how does it work so that you can see KDevelop 4, love it and try it.

– The information shown when hovering the DUChain:
Documentation support integration on tooltip

– The tool view on the right showing the requested information:
Documentation tool view inside KDevelop

:)

12 Comments

  1. I’m extremely pleased an excited with how KDevelop4 is shaping up. I’m using it for my (small) projects and I already find it strange and uneasy to go back to Kate + Konsole. I svn upped today and discovered that the documentation sidebar fits wonderfully on my widescreen. Nice job, I hope a true release is somewhere soonish in the pipeline.

    Comment by Andrew Stromme — 1 March 2009 @ 2:58 am

  2. Looks pretty damn cool :)

    Comment by John Tapsell — 1 March 2009 @ 4:27 am

  3. Really nice stuff :-)

    One thing I did notice, the following caption seams a bit redundant to me:
    – ‘class QString Access: public Type: class’ definition
    why not just “class QString”?

    Comment by Diederik van der Boor — 1 March 2009 @ 10:38 am

  4. Wooow, this’s a very cool feature… Btw, how can you make visible the assistant widget on a second picture? Is it some playground plugin, or plugin in core kdevelop?

    Comment by hron84 — 1 March 2009 @ 1:04 pm

  5. Very nice indeed. All the KDevelop posts look very imperssive and I can’t wait for a stable version.
    What I wonder: Will KDevelop run under Windows or is the Windows “Port” behind and will not be ready when the *nix KDevelop final version hits the surface?

    Keep up the great work folks!

    Comment by gnoro — 1 March 2009 @ 6:20 pm

  6. Cool!

    Comment by Hj — 1 March 2009 @ 10:23 pm

  7. Very useful to be able to see the relevant documentation on demand.

    Keep up the good work

    Comment by Ed — 2 March 2009 @ 8:10 pm

  8. Hi, this looks great!

    Are there any plans to integrate java documentation in this way? Will it be easy using this architecture?

    Thanks!

    Comment by Peter Lewis — 3 March 2009 @ 10:49 am

  9. Thanks for these positive comments! :)

    #5 We have some work towards a Windows version but nobody really working on it, so unless we have someone really pushing it we’re not having support for now. Should be possible to run it on windows, though.

    #8 It is thought to be flexible, so yes, we’re likely to have integration with javadoc at some point (when we have java xD)

    Comment by apol — 6 March 2009 @ 1:09 am

  10. Great. Impressive. This beats every MS VS environment i have ever seen …
    Thanks for the great tool.

    Comment by Andreas S — 2 June 2009 @ 11:17 pm

  11. Can you guide us how to integrate glibc documentation.

    Comment by Agroni — 18 June 2010 @ 5:44 pm

  12. @Agroni You can just create a kdevplatform adapted Documentation plugin.

    You can ask us in the list how to do so.

    Comment by apol — 21 June 2010 @ 4:54 pm

RSS feed for comments on this post. TrackBack URI

Sorry, the comment form is closed at this time.

Powered by WordPress