summaryrefslogtreecommitdiffstats
path: root/parts/doxygen/README.dox
diff options
context:
space:
mode:
authorMichele Calgaro <michele.calgaro@yahoo.it>2014-10-18 23:04:45 +0900
committerMichele Calgaro <michele.calgaro@yahoo.it>2014-10-18 23:04:45 +0900
commit8b32bdf532a706f0305424774506f5016f714c09 (patch)
treef847092af6e7c9033ff9ae07fc9b0d39d2b42927 /parts/doxygen/README.dox
parent85bc8e43e622bc0a7f4bfbeef817a7697ff65b64 (diff)
downloadtdevelop-8b32bdf532a706f0305424774506f5016f714c09.tar.gz
tdevelop-8b32bdf532a706f0305424774506f5016f714c09.zip
Fixed generation of API documentation. Updated TDevelop API documentation toc file. This relates to bug 1859.
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
Diffstat (limited to 'parts/doxygen/README.dox')
-rw-r--r--parts/doxygen/README.dox22
1 files changed, 11 insertions, 11 deletions
diff --git a/parts/doxygen/README.dox b/parts/doxygen/README.dox
index 21dc48b8..9fa7b692 100644
--- a/parts/doxygen/README.dox
+++ b/parts/doxygen/README.dox
@@ -1,8 +1,8 @@
/**
\class DoxygenPart
-Integrates Doxygen - http://www.doxygen.org into KDevelop.
-It allows you to call the Doxygen executable from a KDevelop menu.
-It integrates a GUI into the "KDevelop Project Configuration dialog" to
+Integrates Doxygen - http://www.doxygen.org into TDevelop.
+It allows you to call the Doxygen executable from a TDevelop menu.
+It integrates a GUI into the "TDevelop Project Configuration dialog" to
configure Doxygen (it reads and writes Doxygen Compatible configuration files).
<b>To update to a newer doxygen version:</b>
@@ -21,10 +21,10 @@ configure Doxygen (it reads and writes Doxygen Compatible configuration files).
<br>
-# To do the merge on config.cpp you should use:
<code>\verbatim$ kdiff3 doxygen-location/src/config.cpp tdevelop-location/parts/doxygen/config.cpp\endverbatim</code>
- - Be careful because doxygen uses the deprecated QList class while KDevelop
+ - Be careful because doxygen uses the deprecated QList class while TDevelop
uses the new QPtrList so you should not merge certain lines of code!!!
- Be careful because doxygen uses the deprecated QRegExp::match() method while
- KDevelop uses the new QRegExp::search() and QRegExp::matchedLength() mehtods
+ TDevelop uses the new QRegExp::search() and QRegExp::matchedLength() mehtods
instead so you should not merge certain lines of code!!!
- Be careful because KDevlop uses the QFile::encodeName() function and the
original doxygen code doesn't. So do NOT delete the QFile::encodeName() calls.
@@ -32,15 +32,15 @@ configure Doxygen (it reads and writes Doxygen Compatible configuration files).
<br>
-# To do the merge on config.h you should use:
<code>\verbatim$ kdiff3 doxygen-location/src/config.h tdevelop-location/parts/doxygen/config.h\endverbatim</code>
- - Again, be careful because doxygen uses the deprecated QList class while KDevelop
+ - Again, be careful because doxygen uses the deprecated QList class while TDevelop
uses the new QPtrList so you should not merge certain lines of code!!!
.
<br>
.
-# Copy over the file <code>doxygen-location/src/lang_cfg.h</code> to the <code>tdevelop-location/parts/doxygen/</code> directory.
-# Add the new i18n strings to messages.cpp.
- To do so, run KDevelop and go to Project-> Project Options... -> Doxygen.
- Take a look at KDevelop' console output, it will warn you about the missing
+ To do so, run TDevelop and go to Project-> Project Options... -> Doxygen.
+ Take a look at TDevelop' console output, it will warn you about the missing
messages. Add them to messages.cpp file.
-# Update version.cpp
-# Add anything else you needed to do, to get it to compile, to the parts/doxygen/README.dox file.
@@ -53,10 +53,10 @@ Everything else we can customize for our look & feel.
\maintainer <a href="mailto:a.lucas at tu-bs dot de">Amilcar Lucas</a>
-\feature Call Doxygen executable from a KDevelop menu.
-\feature Configure Doxygen inside KDevelop.
+\feature Call Doxygen executable from a TDevelop menu.
+\feature Configure Doxygen inside TDevelop.
\feature Create a configuration file with correct ProjectName, Author, Version and
- location of source files whenever a new KDevelop project is created.
+ location of source files whenever a new TDevelop project is created.
\feature Automaticaly generate a Doxygen search database whenever the "search engine" option in Doxygen configuration is activated and you "Run Doxygen".