← Back to branch summary

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

« back to all changes in this revision

Viewing changes to parts/doxygen/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:
parts/doxygen/README.dox
 
1
/**
 
2
\class DoxygenPart
 
3
Integrates Doxygen - http://www.doxygen.org into KDevelop.
 
4
It allows you to call the Doxygen executable from a KDevelop menu.
 
5
It integrates a GUI into the "KDevelop Project Configuration dialog" to
 
6
configure Doxygen (it reads and writes Doxygen Compatible configuration files).
 
7
 
 
8
<b>To update to a newer doxygen version:</b>
 
9
 
 
10
  -# Merge over the config.h and config.cpp files from the addon/doxywizard/
 
11
    directory in the doxygen sources.
 
12
    You'll need:
 
13
    - GNU bison v1.34 or better
 
14
    - GNU flex v2.5.4 or better
 
15
    - Kompare from KDEsdk
 
16
    .
 
17
    You'll have to issue:
 
18
        <code>\verbatim$ ./configure --with-doxywizard && make\endverbatim</code>
 
19
    to get the config.h and config.cpp files on this directory.
 
20
    You should also copy config.l if you'd like to do some debugging.
 
21
    <br>
 
22
    -# To do the merge on config.cpp you should use:
 
23
          <code>\verbatim$ kompare doxygen-location/addon/doxywizard/config.cpp kdevelop-location/parts/doxygen/config.cpp\endverbatim</code>
 
24
      - Be careful because doxygen uses the deprecated QList class while KDevelop
 
25
      uses the new QPtrList so you should not merge certain lines of code!!!
 
26
      - Be careful because doxygen uses the deprecated QRegExp::match() method while
 
27
      KDevelop uses the new QRegExp::search() and QRegExp::matchedLength() mehtods
 
28
      instead so you should not merge certain lines of code!!!
 
29
      - Be careful because KDevlop uses the QFile::encodeName() function and the
 
30
      original doxygen code doesn't. So do NOT delete the QFile::encodeName() calls.
 
31
      .
 
32
    <br>
 
33
    -# To do the merge on config.h you should use:
 
34
          <code>\verbatim$ kompare doxygen-location/addon/doxywizard/config.h kdevelop-location/parts/doxygen/config.h\endverbatim</code>
 
35
      - Again, be careful because doxygen uses the deprecated QList class while KDevelop
 
36
      uses the new QPtrList so you should not merge certain lines of code!!!
 
37
      .
 
38
    <br>
 
39
    .
 
40
  -# Copy over the file lang_cfg.h from the src/ directory in the doxygen sources.
 
41
  -# Add the new i18n strings to messages.cpp.
 
42
    To do so, run KDevelop and go to Project-> Project Options... -> Doxygen.
 
43
    Take a look at KDevelop' console output, it will warn you about the missing
 
44
    messages. Add them to messages.cpp file.
 
45
  -# Update version.cpp
 
46
  -# Add anything else you needed to do, to get it to compile, to the parts/doxygen/README.dox file.
 
47
 
 
48
Everything else we can customize for our look & feel.
 
49
 
 
50
\authors <a href="mailto:dimitri AT stack.nl">Dimitri van Heesch</a>
 
51
 
 
52
\maintainer <a href="mailto:bernd AT kdevelop.org">Bernd Gehrmann</a>
 
53
\maintainer <a href="mailto:a.lucas at tu-bs dot de">Amilcar Lucas</a>
 
54
 
 
55
 
 
56
\feature Call Doxygen executable from a KDevelop menu.
 
57
\feature Configure Doxygen inside KDevelop.
 
58
\feature Create a configuration file with correct ProjectName, Author, Version and
 
59
    location of source files whenever a new KDevelop project is created.
 
60
\feature Automaticaly generate a Doxygen search database whenever the "search engine" option in Doxygen configuration is activated and you "Run Doxygen".
 
61
 
 
62
 
 
63
\requirement You need to install the <a href="http://www.doxygen.org">Doxygen</a> binaries in your machine. This part supports
 
64
all versions up to the version stated on the version.cpp file. As usual it is
 
65
recomended to use the latest version or at least >= 1.3.4.
 
66
\requirement It is recomended that you also install <a href="http://www.graphviz.org">dot</a> >= 1.8.7 (tool to generate graphical
 
67
dependencies).
 
68
 
 
69
 
 
70
\bug doesn't resize the configuration GUI properly.
 
71
 
 
72
 
 
73
\faq <b>Do I need to install Doxygen?</b>
 
74
     Yes
 
75
*/