Bug 80463 - Smart HTML Documentation in a dock window (wish)
Summary: Smart HTML Documentation in a dock window (wish)
Status: RESOLVED FIXED
Alias: None
Product: kdevelop
Classification: Applications
Component: Documentation viewer (show other bugs)
Version: unspecified
Platform: Compiled Sources Linux
: NOR wishlist
Target Milestone: ---
Assignee: kdevelop-bugs-null
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-04-27 14:23 UTC by Paul Drummond
Modified: 2008-06-29 19:35 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Paul Drummond 2004-04-27 14:24:00 UTC
Version:            (using KDE Devel)
Installed from:    Compiled sources
Compiler:          g++ 
OS:          Linux

One feature I would like in KDevelop is the ability to view HTML docs while also viewing source code.  I know this is possible in ChildFrame mode, but I prefer IDEAl mode.  

By putting the documentation in a dockwindow, it would be possible to see it always and hide it when necessary.  

Also, could provide a "Smart" feature where the page automatically changes to show the HTML for the class under the cursor (using the CLASS STORE database).

This "Smart Documentation" would be designed to aid a developer and would not provide an index/contents like the current doc-parts.  It would simply display the QT and KDE API documentation, and maybe the user's project documentation.

I would have an attempt at implementing this, but would like some feedback as to whether you guys think its a good idea first.  

I don't want to tread on anyone's toes as there are already two documentation parts in HEAD already - do we need another one?  Maybe the current doc-part could be extended to provide this feature?  Maybe it is not practical to have a "HTML page" in a dock-window (if not KHTMLPart, could do a simple KTextBrowser?)?  I'm not sure but would be willing to investigate :)
Comment 1 Alexander Dymo 2004-07-20 22:22:57 UTC
I think "Look in documentation" is close to your "smart documentation". It looks for keys in documentation index. If Qt and/or KDE documentation index is enabled, and, for example, Qt class is looked in index, you should only press enter to go to the class documentation.
Comment 2 Jens Dagerbo 2006-12-31 02:45:18 UTC
With the ability of KDevelop-3.4's UI to split views, this is sorta implemented now. It's quite possible to have code and documentation side by side.
Comment 3 Andreas Pakulat 2008-06-29 19:35:41 UTC
in kdev4 we have area's for this, so you can have multiple mainwindows showing documentation and code. Fixed for me.