Bug 78457

Summary:	Wishlist for Documentation part
Product:	[Applications] kdevelop	Reporter:	Boris S <boris_s>
Component:	Documentation viewer	Assignee:	kdevelop-bugs-null
Status:	RESOLVED WORKSFORME
Severity:	wishlist
Priority:	NOR
Version:	3.0.0
Target Milestone:	---
Platform:	RedHat Enterprise Linux
OS:	Linux
Latest Commit:		Version Fixed In:

Description Boris S 2004-03-25 22:53:16 UTC

Version:           3.x.x (using KDE KDE 3.2.1)
Installed from:    RedHat RPMs
OS:          Linux

I would like to see the following changes in the way Kdevelop 3.x.x handles documentation

1. Give us back c/c++ reference guide.
   I don't understand  the reason it had been removed from latest versions of Kdevelop.
   It was an excellent guide and much effort had been down to compile it. It is very useful 
   to have such reference handy even for C/C++ gurus.

2. Local Documentation is a MUST.
   I don't believe that a decision to have an online documentation only was a right one.
   For example, I do most of my development on a laptop, and internet is not always available

Comment 1 Jens Dagerbo 2004-03-25 23:18:17 UTC

1. I always found the c++ reference to be pretty crappy, but I guess it couldn't hurt to make it possible to include it.

2. Very impractical. The total sum of documentation KDevelop makes available via online resources is measured in hundreds of megabytes. Just the KDE API alone is three times the size of the KDevelop source itself. It's simply not reasonable to think that we could package the documentation together with KDevelop. 

You will need to download and install documentation yourself, and then configure the KDevelop documentation plugin to see it.

Comment 2 meldroc 2004-05-05 03:39:48 UTC

How about some sample .toc files for common collections of offline docs?  GNU's docs to libc and libstdc++, or offline .tocs for SDL, the autobook, etc. Maybe a modification to the documentation plugin so you can just go to prefs, click "Add other documentation", browse to a file somewhere in /usr/share/doc/ and automagically add something to the doc tree even if it's just a massive mess of links.

Having docs only online is very inconvenient for me, and I don't have the time or inclination to spend a week figuring out .toc files.

Comment 3 Alan Ezust 2005-12-13 22:23:29 UTC

I get doxygen .tag files installed when I apt-get install kdelibs4-doc.

/usr/share/doc/kde/HTML/en/kdelibs-apidocs

I tried importing these into KDEvelop and they "kinda" worked.

Comment 4 Andreas Pakulat 2008-06-29 18:45:21 UTC

you can add c/c++ reference yourself.