summaryrefslogtreecommitdiffstats
path: root/doc/api
diff options
context:
space:
mode:
authorMichele Calgaro <michele.calgaro@yahoo.it>2014-05-25 15:37:31 +0900
committerMichele Calgaro <michele.calgaro@yahoo.it>2014-05-25 15:37:31 +0900
commit6392f5a9dfce2bf83617d49bb7f332181ec6004e (patch)
treeab69e390f7962b7e7dda1a3a64f035c61c751cf4 /doc/api
parentaba2788b428dc53243407902e9ccbb20b97a69fd (diff)
downloadtdevelop-6392f5a9dfce2bf83617d49bb7f332181ec6004e.tar.gz
tdevelop-6392f5a9dfce2bf83617d49bb7f332181ec6004e.zip
Revert "Finish renaming tdevelop components"
This reverts commit 722ce1efbac31c61b1d4b13f7e075c9f311e3e73.
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/Architecture.dox16
-rw-r--r--doc/api/FutureTasks.dox2
-rw-r--r--doc/api/HighPriTasks.dox2
-rw-r--r--doc/api/HowToAddApplicationTemplates.dox12
-rw-r--r--doc/api/HowToAddGenericBuildTools.dox2
-rw-r--r--doc/api/HowToAddPlugins.dox10
-rw-r--r--doc/api/HowToAddProgrammingLanguages.dox10
-rw-r--r--doc/api/HowToDocument.dox4
8 files changed, 29 insertions, 29 deletions
diff --git a/doc/api/Architecture.dox b/doc/api/Architecture.dox
index 52c1447a..ae4ef73d 100644
--- a/doc/api/Architecture.dox
+++ b/doc/api/Architecture.dox
@@ -40,7 +40,7 @@ parts to distinguish, mainly:
- src = The core part of KDevelop
- lib/interfaces = Plugin handler interface classes
- - parts = The various parts using the KParts framework ( TDevPlugin children )
+ - parts = The various parts using the KParts framework ( KDevPlugin children )
- languages = \ref language-parts
- buildtools = \ref buildtool-parts
- vcs = \ref vcs-parts
@@ -67,12 +67,12 @@ There are two types of possible main window objects:
pre-arranged access tabs around user areas.
.
-Both main window classes inherit from the TDevMainWindow class which provides
+Both main window classes inherit from the KDevMainWindow class which provides
access to common window features.
\subsubsection toplevel The TopLevel Object
-There is only one toplevel object of class TDevMainWindow in KDevelop. It can
+There is only one toplevel object of class KDevMainWindow in KDevelop. It can
be accessed through the static function TopLevel::getInstance() (see the
TopLevel class).
@@ -83,7 +83,7 @@ be viewed according to their functionalities as follows.
\subsubsection language-parts Programming Language Support Parts
-These parts implement a TDevLanguageSupport Class interface.
+These parts implement a KDevLanguageSupport Class interface.
To add support for a new programming language check the \ref howToAddProgrammingLanguages page (doc/api/HowToAddProgrammingLanguages.dox file).
Take a look at \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) to see the current status/features of the programming languages currently supported by KDevelop.
@@ -135,7 +135,7 @@ Take a look at \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) to se
\subsubsection buildtool-parts Build tools Parts
-These parts implement a TDevProject Class interface.
+These parts implement a KDevProject Class interface.
- buildtools/ada = Ada build tool
- (see AdaProjectPart)
@@ -166,7 +166,7 @@ These parts implement a TDevProject Class interface.
\subsubsection vcs-parts VCS (Version Control System) Parts
-These parts implement a TDevVersionControl Class interface.
+These parts implement a KDevVersionControl Class interface.
- vcs/cervisia = Cervisia Support
- (see CervisiaPlugin)
@@ -211,7 +211,7 @@ Take a look at \ref EditorsSupportStatus (doc/api/EditorsSupportStatus.dox file)
Some of the parts are considered global - that is, they effect the entire
operation of KDevelop.
-These parts implement a TDevPlugin Class interface.
+These parts implement a KDevPlugin Class interface.
- parts/appwizard = New Project Wizard
- see AppWizardPart
@@ -264,7 +264,7 @@ These parts implement a TDevPlugin Class interface.
\subsubsection project-specific-parts Project Specific Parts
-These parts implement a TDevPlugin Class interface.
+These parts implement a KDevPlugin Class interface.
- parts/astyle = Source code formatter
- (see AStylePart)
diff --git a/doc/api/FutureTasks.dox b/doc/api/FutureTasks.dox
index 763537f3..1d7f7f26 100644
--- a/doc/api/FutureTasks.dox
+++ b/doc/api/FutureTasks.dox
@@ -129,7 +129,7 @@
the same border as other items (impossible)
- Browser tool bar should truncate long menu entries so it doesn't
take so much space (already implemented?)
- - Extend TDevPlugin-API in order to have a preferred border for at
+ - Extend KDevPlugin-API in order to have a preferred border for at
least the selection parts (Automake Manager, Class Browser, File
Groups, etc...)
diff --git a/doc/api/HighPriTasks.dox b/doc/api/HighPriTasks.dox
index 7bcbaf1f..062b3b06 100644
--- a/doc/api/HighPriTasks.dox
+++ b/doc/api/HighPriTasks.dox
@@ -12,7 +12,7 @@
This way the .tdevelop file can be shared in teams of developers.
-\section TDevelop2compat KDevelop 2 compatibility
+\section KDevelop2compat KDevelop 2 compatibility
(These are things that must be accomplished before we can say that KDevelop 3
&gt;= tdevelop 2.x UI-wise and functionality-wise!)
diff --git a/doc/api/HowToAddApplicationTemplates.dox b/doc/api/HowToAddApplicationTemplates.dox
index 1da5a3e5..f53ce4f8 100644
--- a/doc/api/HowToAddApplicationTemplates.dox
+++ b/doc/api/HowToAddApplicationTemplates.dox
@@ -27,7 +27,7 @@ applications like kedit as well as plugins for example for tdevelop or noatun.\n
\section templates_1 I. Example: How To Create a Simple KDE Application Template "KHello"
-You can find this template in <code>$TDEDIR/share/apps/tdevappwizard/template-khello</code>.
+You can find this template in <code>$TDEDIR/share/apps/kdevappwizard/template-khello</code>.
\subsection templates_1_1 I.1. Step 1: Basic Skeleton
@@ -64,7 +64,7 @@ wizard will replace:
- \%{YEAR} ........ by the year
.
</pre></code>
-All this can be found in <code>$TDEDIR/share/apps/tdevappwizard/template-common/tdevelop.pm</code>.
+All this can be found in <code>$TDEDIR/share/apps/kdevappwizard/template-common/tdevelop.pm</code>.
\subsubsection templates_1_2a I.2.1. The Source Files
The files <code>template-khello/app.cpp, template-khello/app.h</code> and
@@ -135,22 +135,22 @@ if [ `id -u` = 0 ]; then
# we are root so install the template into the global kde directory
kde_dir=`tde-config --prefix`
else
- # we are a user so install it into $HOME/.trinity/share/apps/tdevappwizard directory
+ # we are a user so install it into $HOME/.trinity/share/apps/kdevappwizard directory
kde_dir=`tde-config --localprefix`
echo "Note: It would be better to install as root. Press CTRL+C to abort"
fi
# use usual path or another one?
-echo "Install dir [${kde_dir}/share/apps/tdevappwizard]:"
+echo "Install dir [${kde_dir}/share/apps/kdevappwizard]:"
read newdir
-if [ "$newdir"a = a ]; then newdir="${kde_dir}/share/apps/tdevappwizard/"; fi
+if [ "$newdir"a = a ]; then newdir="${kde_dir}/share/apps/kdevappwizard/"; fi
# make sure the directories exist
if [ ! -e "${newdir}/template-khello" ]; then mkdir -p "${newdir}/template-khello" ; fi;
if [ ! -e "${newdir}/templates" ]; then mkdir -p "${newdir}/templates" ; fi;
if [ ! -e "${newdir}" ]; then mkdir -p "$newdir" ; fi;
-if [ ! -e "${newdir}/template-common" ]; then ln -s "${kde_prefix}/share/apps/tdevappwizard/template-common" "${newdir}/template-common" ; fi;
+if [ ! -e "${newdir}/template-common" ]; then ln -s "${kde_prefix}/share/apps/kdevappwizard/template-common" "${newdir}/template-common" ; fi;
# install now
cp -R --target-directory "$newdir" template-khello
diff --git a/doc/api/HowToAddGenericBuildTools.dox b/doc/api/HowToAddGenericBuildTools.dox
index d713082a..b073cf0f 100644
--- a/doc/api/HowToAddGenericBuildTools.dox
+++ b/doc/api/HowToAddGenericBuildTools.dox
@@ -6,7 +6,7 @@
This part offers build tool facilities using project files in xml format (dtd is located in buildtools/generic/kdevxmlproject.dtd).
Those xml files can be converted into makefiles, ant xml files or simply shell scripts using build system plugins.
-Build system plugin is an object that implements TDevBuildSystem interface.
+Build system plugin is an object that implements KDevBuildSystem interface.
Build system plugins are located in buildtools/generic/buildsystem.
\section sectionStep1 Step 1: Make your plugin loadable
diff --git a/doc/api/HowToAddPlugins.dox b/doc/api/HowToAddPlugins.dox
index b0b282db..fa7f74e2 100644
--- a/doc/api/HowToAddPlugins.dox
+++ b/doc/api/HowToAddPlugins.dox
@@ -8,7 +8,7 @@
For a plugin <code>foo</code>, create a file <code>foo.desktop</code> which contains KDevelop/Part in its list of ServiceTypes.
- - See <code>parts/doctreeview/tdevdoctreeview.desktop</code> for an example.
+ - See <code>parts/doctreeview/kdevdoctreeview.desktop</code> for an example.
.
If you install this file into <code>\$(kde_servicesdir)</code>, your plugin will automatically be loaded.
@@ -80,9 +80,9 @@ See <code>parts/doctreeview/doctreeviewfactory.cpp</code> for an example.
\section implementPart Step 3: Implement your part.
-Your part must be derived from <code>TDevPlugin</code>.
+Your part must be derived from <code>KDevPlugin</code>.
- - TDevPlugin takes two arguments:
+ - KDevPlugin takes two arguments:
- 1) A <i>parent</i> argument. This also comes from
<code>createPartObject()</code>.
- 2) A <i>name</i>, which in turn is given to the <code>QObject</code>
@@ -93,7 +93,7 @@ Your part must be derived from <code>TDevPlugin</code>.
\subsection accessIDE How to access other IDE components
A part can access other components of the IDE via some accessors
-of <code>TDevPlugin</code>:
+of <code>KDevPlugin</code>:
- The <i>application core</i> via <code>core()</code>,
- the <i>build tools</i> via <code>project()</code>,
@@ -155,7 +155,7 @@ to write it back.
\subsection sessionAccess Project session file (*.kdevses)
-The base class of all TDevelop plugins is TDevPlugin. It provides two virtual methods
+The base class of all TDevelop plugins is KDevPlugin. It provides two virtual methods
restorePartialProjectSession(..) and savePartialProjectSession(..)
that you should reimplement in your special plugin to attach to session loading and saving.
diff --git a/doc/api/HowToAddProgrammingLanguages.dox b/doc/api/HowToAddProgrammingLanguages.dox
index 5dd44fda..a5840885 100644
--- a/doc/api/HowToAddProgrammingLanguages.dox
+++ b/doc/api/HowToAddProgrammingLanguages.dox
@@ -6,7 +6,7 @@
\section LSupport List of things to have "complete" support of a given language in KDevelop
- - Implement interface TDevLanguageSupport
+ - Implement interface KDevLanguageSupport
- \ref sectionClassWizard
- \ref sectionAttributeMethodWizard
- \ref sectionQtUiSubclassing - (if the language has Qt bindings)
@@ -43,7 +43,7 @@ Take a look at \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) to se
\section sectionLanguageSupport Language Support
Any language support should be written as a tdevelop part and implement
-TDevLanguageSupport interface (<code>lib/interfaces/tdevlanguagesupport.h</code>).
+KDevLanguageSupport interface (<code>lib/interfaces/kdevlanguagesupport.h</code>).
Implementing methods:
- <code>virtual Features features();</code>
@@ -54,7 +54,7 @@ Should be enough for a language support to start working.
KDevelop ships with KDevLang project template. It is a simple language support prototype that can be used when developing language support plugins with KDevelop.
To use it, start a New Project and select: <code>C++->KDevelop->KDevelop Language Support Plugin</code> in the application wizard.
-The template is located in <code>languages/cpp/app_templates/tdevlang</code>, you can change it there if you need.
+The template is located in <code>languages/cpp/app_templates/kdevlang</code>, you can change it there if you need.
You should look at <code>languages/ruby</code> for a simple language support
@@ -177,7 +177,7 @@ write a <b>Debugger </b>. KDevelop already provides GDB support
\subsection sectionCompilerPlugins Compiler plugins
There is an ability to create compiler plugin for KDevelop. Compiler plugin provides the compiler configuration dialog which implements command line compiler options.
-Compiler plugins must implement TDevCompilerOptions interface.
+Compiler plugins must implement KDevCompilerOptions interface.
\section MiscInf Other Info
@@ -226,7 +226,7 @@ currently provides several build tools. They are:
- see GenericProjectPart at <code>buildtools/generic</code>
- Offers build tool facilities using project files in xml format (dtd is located in <code>buildtools/generic/kdevxmlproject.dtd</code>).
Those xml files can be converted into makefiles, ant xml files or simply shell scripts using build system plugins.
- Build system plugin is an object that implements TDevBuildSystem interface. Build system plugins are located in <code>buildtools/generic/buildsystem</code>.
+ Build system plugin is an object that implements KDevBuildSystem interface. Build system plugins are located in <code>buildtools/generic/buildsystem</code>.
.
- QMake build tool
- see TrollProjectPart at <code>buildtools/qmake</code>
diff --git a/doc/api/HowToDocument.dox b/doc/api/HowToDocument.dox
index 65cd7c31..d606a8bf 100644
--- a/doc/api/HowToDocument.dox
+++ b/doc/api/HowToDocument.dox
@@ -3,7 +3,7 @@
*/
/** \page howToDocument How to document KDevelop parts
-You should add a README and a README.dox file to your part (TDevPlugin).
+You should add a README and a README.dox file to your part (KDevPlugin).
On the README file put this text:
\verbatim
@@ -31,7 +31,7 @@ implements your part.
On the area marked with <code>...</code> you can add optional informations. Here is an example of that:
-\verbinclude languages/cpp/app_templates/tdevpart/README.dox
+\verbinclude languages/cpp/app_templates/kdevpart/README.dox
All these infos are optional and you should only add the link to the bugzilla database if YOUR_COMPONENT_NAME
has been defined in that database.