← Back to branch summary

~ubuntu-branches/debian/sid/kdevelop/sid

« back to all changes in this revision

Viewing changes to languages/cpp/README.dox

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Lainé
  • Date: 2006-05-23 18:39:42 UTC
  • Revision ID: james.westby@ubuntu.com-20060523183942-hucifbvh68k2bwz7
Tags: upstream-3.3.2
Import upstream version 3.3.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
languages/cpp/README.dox
 
1
/** \class CppSupportPart
 
2
Provides C/C++ language support for KDevelop.
 
3
 
 
4
Well the first thing you should read is lib/catalog it contains the source of the persistant class store
 
5
after that languages/cpp/tag_creator.*
 
6
it is the component that stores the informations collected by the c++ parser into the PCS
 
7
then you can play with KDevPCSImporter the code of the dialog is in languages/cpp/createpcsdialog* and languages/cpp/pcsimporter/*
 
8
and of course lib/interfaces/kdevpcsimporter.*
 
9
and if you want play with the c++ parser go to lib/cppparser/, the best is to start to read driver.*
 
10
 
 
11
\authors <a href="mailto:roberto AT kdevelop.org">Roberto Raggi</a>
 
12
 
 
13
\maintainer <a href="mailto:roberto AT kdevelop.org">Roberto Raggi</a>
 
14
 
 
15
\feature supports C/C++ language
 
16
\feature can do code completion
 
17
\feature has presistent class store
 
18
\feature code highlight
 
19
\feature Consult \ref LangSupportStatus for a up to date features/status of this programming language support part.
 
20
 
 
21
\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>
 
22
 
 
23
\faq <b>How can I have documentation on functions when using codecompletion ?</b>
 
24
  -# Create the xml-output with <a href="http://www.doxygen.org">Doxygen</a> of the files you want to add to the classstore
 
25
  -# 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.
 
26
     It is used like -d/path/of/doxygen/xml/output (notice that there is _no_ whitespace between -d and the path!).
 
27
     You can use it multiple times to have r++ search for the informations in different directories.
 
28
     r++ -d has to be used (like every other commandline switch) before you write the directories you want r++ to create the PCSdatabase from.
 
29
  -# Activate your newly created Database in the Project->Project Options...->C++ Specific->Code Completion...
 
30
  .
 
31
\faq <b>How does this work ?</b> I have no clue. Ask roberto! :)
 
32
\faq <b>How does r++ work ?</b> I have no clue. Ask roberto! :)
 
33
 
 
34
*/