Review Request 115991: Be able to get documentation for type of instances

Kevin Funk kfunk at kde.org
Mon Feb 24 09:44:02 UTC 2014



> On Feb. 24, 2014, 9:02 a.m., Milian Wolff wrote:
> > In principle this is fine, but what this will break (or will it?), is the case where you add custom Doxygen to a variable/member. In such a case, you'll now only see the builtin Qt documentation, no?
> > 
> > i.e.:
> > 
> > class foo {
> >   /**
> >    * Fancy comment should be shown in documentation.
> >    */
> >   QPoint bar;
> > };
> > 
> > Would be cool if we could combine both documentations somehow... But probably thats not feasible. So I'd vote to make it only fall back to builtin documentation if no other documentation exists.

That still works, comments are still prepended to the navigation widget (handled by abstractdeclarationnavigationcontext.cpp separately).

However, I've just noticed that the navigation widget now shows "Show documentation for 'foo::bar'" instead of 'QPoint', which is misleading. I'll give this patch another thought.

But being able to quickly fire up the documentation for anything under your cursor is quite helpful, IMO, other IDEs do that, too.


- Kevin


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/115991/#review50633
-----------------------------------------------------------


On Feb. 24, 2014, 8:53 a.m., Kevin Funk wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/115991/
> -----------------------------------------------------------
> 
> (Updated Feb. 24, 2014, 8:53 a.m.)
> 
> 
> Review request for KDevelop.
> 
> 
> Repository: kdevplatform
> 
> 
> Description
> -------
> 
> Be able to get documentation for type of instances
> 
> Example:
> "QPoint point;"
>         ^-- cursor here
> 
> => Now the "Show Documentation" shortcut retrieves the help of "QPoint",
> didn't do anything before this patch.
> 
> 
> Diffs
> -----
> 
>   shell/documentationcontroller.cpp 2ea4347ed0492d8ffa2fc67c7bf2e68ad61c703c 
> 
> Diff: https://git.reviewboard.kde.org/r/115991/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Kevin Funk
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kdevelop-devel/attachments/20140224/0e477289/attachment.html>


More information about the KDevelop-devel mailing list