From 114a878c64ce6f8223cfd22d76a20eb16d177e5e Mon Sep 17 00:00:00 2001
From: toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>
Date: Wed, 25 Nov 2009 17:56:58 +0000
Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
 BUG:215923

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdevelop@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
---
 languages/cpp/README.dox | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 languages/cpp/README.dox

(limited to 'languages/cpp/README.dox')

diff --git a/languages/cpp/README.dox b/languages/cpp/README.dox
new file mode 100644
index 00000000..ba1fbc05
--- /dev/null
+++ b/languages/cpp/README.dox
@@ -0,0 +1,34 @@
+/** \class CppSupportPart
+Provides C/C++ language support for KDevelop.
+
+Well the first thing you should read is lib/catalog it contains the source of the persistant class store
+after that languages/cpp/tag_creator.*
+it is the component that stores the informations collected by the c++ parser into the PCS
+then you can play with KDevPCSImporter the code of the dialog is in languages/cpp/createpcsdialog* and languages/cpp/pcsimporter/*
+and of course lib/interfaces/kdevpcsimporter.*
+and if you want play with the c++ parser go to lib/cppparser/, the best is to start to read driver.*
+
+\authors <a href="mailto:roberto AT kdevelop.org">Roberto Raggi</a>
+
+\maintainer <a href="mailto:roberto AT kdevelop.org">Roberto Raggi</a>
+
+\feature supports C/C++ language
+\feature can do code completion
+\feature has presistent class store
+\feature code highlight
+\feature Consult \ref LangSupportStatus for a up to date features/status of this programming language support part.
+
+\bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=kdevelop&component=cppsupport&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number">cppsupport component at Bugzilla database</a>
+
+\faq <b>How can I have documentation on functions when using codecompletion ?</b>
+  -# Create the xml-output with <a href="http://www.doxygen.org">Doxygen</a> of the files you want to add to the classstore
+  -# Create the new PCS-database with r++. Now you have to use the -d command line switch of r++ to have it include the documentation.
+     It is used like -d/path/of/doxygen/xml/output (notice that there is _no_ whitespace between -d and the path!).
+     You can use it multiple times to have r++ search for the informations in different directories.
+     r++ -d has to be used (like every other commandline switch) before you write the directories you want r++ to create the PCSdatabase from.
+  -# Activate your newly created Database in the Project->Project Options...->C++ Specific->Code Completion...
+  .
+\faq <b>How does this work ?</b> I have no clue. Ask roberto! :)
+\faq <b>How does r++ work ?</b> I have no clue. Ask roberto! :)
+
+*/
-- 
cgit v1.2.3