diff options
47 files changed, 209 insertions, 184 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 51988055..d4dc4db5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -41,6 +41,17 @@ include( TDESetupPaths ) tde_setup_paths( ) +##### add apidox targets ############ + +add_custom_target(apidox + COMMAND "./generate_apidox" "${CMAKE_SOURCE_DIR}" "${CMAKE_BINARY_DIR}" "${HTML_INSTALL_DIR}" "/usr/share/tqt3/doc/html" + WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}/cmake/") + +add_custom_target(install-apidox + COMMAND "./install_apidox" "${CMAKE_SOURCE_DIR}" "${CMAKE_BINARY_DIR}" "${HTML_INSTALL_DIR}" "${CMAKE_INSTALL_PREFIX}" + WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}/cmake/") + + ##### build tools ############################### option( WITH_BUILDTOOL_ALL "Enable all build tools" OFF ) diff --git a/buildtools/lib/base/Mainpage.dox b/buildtools/lib/base/Mainpage.dox index 3e16d2d8..556e703a 100644 --- a/buildtools/lib/base/Mainpage.dox +++ b/buildtools/lib/base/Mainpage.dox @@ -1,7 +1,7 @@ /** -@mainpage The KDevelop Buildtool Base Library +@mainpage The TDevelop Buildtool Base Library -This library contains base classes for KDevelop builtool support plugins. +This library contains base classes for TDevelop builtool support plugins. <b>Link with</b>: -lkdevbuildbase @@ -10,7 +10,7 @@ This library contains base classes for KDevelop builtool support plugins. \section btbaseoverview Overview This library is created to provide KDevBuildTool compat class which can be used as drop-in replacement of KDevProject class for buildtool support plugins -written for old KDevelop architecture (before version 3.2). +written for old TDevelop architecture (before version 3.2). Nevertheless, it can be useful for new buildtool plugins as well because it provides useful methods to get application and make frontend extensions. diff --git a/buildtools/lib/parsers/autotools/Mainpage.dox b/buildtools/lib/parsers/autotools/Mainpage.dox index d54178ee..e1e9176e 100644 --- a/buildtools/lib/parsers/autotools/Mainpage.dox +++ b/buildtools/lib/parsers/autotools/Mainpage.dox @@ -1,5 +1,5 @@ /** -@mainpage The KDevelop Makefile.am Parser +@mainpage The TDevelop Makefile.am Parser This library contains a parser that handles Makefile.am. diff --git a/buildtools/lib/parsers/qmake/Mainpage.dox b/buildtools/lib/parsers/qmake/Mainpage.dox index 82270be0..c1508045 100644 --- a/buildtools/lib/parsers/qmake/Mainpage.dox +++ b/buildtools/lib/parsers/qmake/Mainpage.dox @@ -1,5 +1,5 @@ /** -@mainpage The KDevelop QMake Parser +@mainpage The TDevelop QMake Parser This library contains qmake parser. diff --git a/buildtools/lib/widgets/Mainpage.dox b/buildtools/lib/widgets/Mainpage.dox index 750061c1..416b803f 100644 --- a/buildtools/lib/widgets/Mainpage.dox +++ b/buildtools/lib/widgets/Mainpage.dox @@ -1,5 +1,5 @@ /** -@mainpage The KDevelop Buildtool Widgets Library +@mainpage The TDevelop Buildtool Widgets Library This library contains widgets commonly used in buildtool support plugins. diff --git a/doc/api/Architecture.dox b/doc/api/Architecture.dox index ae4ef73d..ccf09093 100644 --- a/doc/api/Architecture.dox +++ b/doc/api/Architecture.dox @@ -1,15 +1,15 @@ /** \file Architecture.dox - * \brief KDevelop architecture + * \brief TDevelop architecture */ -/** \page architecture KDevelop 3 Architecture +/** \page architecture TDevelop 3 Architecture -KDevelop uses a plugin based architecture. This will be explained in more +TDevelop uses a plugin based architecture. This will be explained in more detail in the next sections. To add a new plugin check the \ref howToAddPlugins page. \section devteammodel Development Team cooperation model -KDevelop is the result of the work of many people. To help syncronize the effords and to automate +TDevelop is the result of the work of many people. To help syncronize the effords and to automate some tasks, the team uses many tools: - CVS servers @@ -22,7 +22,7 @@ some tasks, the team uses many tools: - LXR - E-mail :) - Cron Jobs - - and of course KDevelop :) + - and of course TDevelop :) . They get interconnected like this: @@ -34,11 +34,11 @@ They get interconnected like this: \subsection source-division Main Source Divisions -The KDevelop 3 source is divided into several parts which correspond to -subdirectories in the KDevelop project directory. There are several main +The TDevelop 3 source is divided into several parts which correspond to +subdirectories in the TDevelop project directory. There are several main parts to distinguish, mainly: - - src = The core part of KDevelop + - src = The core part of TDevelop - lib/interfaces = Plugin handler interface classes - parts = The various parts using the KParts framework ( KDevPlugin children ) - languages = \ref language-parts @@ -51,7 +51,7 @@ parts to distinguish, mainly: This image is not complete there are parts that are not displayed. See below for a more detailed description. -\subsection core-part The Core Part of KDevelop +\subsection core-part The Core Part of TDevelop \subsubsection mainwindows Main Window Objects @@ -72,11 +72,11 @@ access to common window features. \subsubsection toplevel The TopLevel Object -There is only one toplevel object of class KDevMainWindow in KDevelop. It can +There is only one toplevel object of class KDevMainWindow in TDevelop. It can be accessed through the static function TopLevel::getInstance() (see the TopLevel class). -\subsection parts-overview KDevelop Parts Overview +\subsection parts-overview TDevelop Parts Overview All parts reside in dedicated subdirectories acording to their function. They can be viewed according to their functionalities as follows. @@ -85,7 +85,7 @@ be viewed according to their functionalities as follows. 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. +Take a look at \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) to see the current status/features of the programming languages currently supported by TDevelop. - languages/ada = Support for Ada - (see AdaSupportPart) @@ -192,7 +192,7 @@ These parts implement a KDevVersionControl Class interface. \subsubsection editor-parts editor support Specific Parts These parts implement a KTextEditor Class interface. -Take a look at \ref EditorsSupportStatus (doc/api/EditorsSupportStatus.dox file) to see the current status/features of the editors currently supported by KDevelop. +Take a look at \ref EditorsSupportStatus (doc/api/EditorsSupportStatus.dox file) to see the current status/features of the editors currently supported by TDevelop. - editors/editor-chooser = Chooses an internal text editor - (see EditorChooserPart) @@ -209,7 +209,7 @@ Take a look at \ref EditorsSupportStatus (doc/api/EditorsSupportStatus.dox file) \subsubsection global-parts Global Parts Some of the parts are considered global - that is, they effect the entire -operation of KDevelop. +operation of TDevelop. These parts implement a KDevPlugin Class interface. diff --git a/doc/api/EditorsSupportStatus.dox b/doc/api/EditorsSupportStatus.dox index e826471c..41a72314 100644 --- a/doc/api/EditorsSupportStatus.dox +++ b/doc/api/EditorsSupportStatus.dox @@ -4,9 +4,9 @@ /** \page EditorsSupportStatus Editors Support Status -Kate and Kvim are part of KDE and KDevelop just uses them. +Kate and Kvim are part of KDE and TDevelop just uses them. -qeditor and Nedit are interfaced via KDevelop's code. You can look at their code at <code>editors/qeditor</code> and <code>editors/nedit</code>. +qeditor and Nedit are interfaced via TDevelop's code. You can look at their code at <code>editors/qeditor</code> and <code>editors/nedit</code>. <table border="1" style="text-align: left; margin-left: auto; margin-right: auto;" cellpadding="2" cellspacing="2"> <tr> diff --git a/doc/api/FutureTasks.dox b/doc/api/FutureTasks.dox index 1d7f7f26..dbf81c66 100644 --- a/doc/api/FutureTasks.dox +++ b/doc/api/FutureTasks.dox @@ -1,7 +1,7 @@ /** \file FutureTasks.dox - * \brief Future tasks and ideas for the next release of KDevelop + * \brief Future tasks and ideas for the next release of TDevelop */ -/** \page FutureTasks Future tasks and ideas for the next release of KDevelop +/** \page FutureTasks Future tasks and ideas for the next release of TDevelop \section codereftodo Code Refactoring / Improvements: @@ -20,7 +20,7 @@ tool (qmake, automake,...?), etc.., too. - use mimetype to determine code files, not extension (see bug # - - Make the help buttons (that we already have) open the KDevelop Handbook on + - Make the help buttons (that we already have) open the TDevelop Handbook on the correct page (or the index if the subject is not covered yet). - New and improved VCS framework (Needs better description) - Another look at the plugin system (Nees better description) diff --git a/doc/api/HighPriTasks.dox b/doc/api/HighPriTasks.dox index 062b3b06..850053f9 100644 --- a/doc/api/HighPriTasks.dox +++ b/doc/api/HighPriTasks.dox @@ -12,8 +12,8 @@ This way the .tdevelop file can be shared in teams of developers. -\section KDevelop2compat KDevelop 2 compatibility -(These are things that must be accomplished before we can say that KDevelop 3 +\section TDevelop2compat TDevelop 2 compatibility +(These are things that must be accomplished before we can say that TDevelop 3 >= tdevelop 2.x UI-wise and functionality-wise!) - general UI issues: diff --git a/doc/api/HowToAddApplicationTemplates.dox b/doc/api/HowToAddApplicationTemplates.dox index f53ce4f8..4b77b9e2 100644 --- a/doc/api/HowToAddApplicationTemplates.dox +++ b/doc/api/HowToAddApplicationTemplates.dox @@ -162,13 +162,13 @@ echo "done" \n \attention Please test your template whether it installs and behaves correctly! Test, test and test again! ;) -\section templates_3 III. How To Add The Template To KDevelop CVS HEAD +\section templates_3 III. How To Add The Template To TDevelop CVS HEAD This section is for tdevelop developers only. Most probably you don't have to read this!.\n Move the directory <code>"template-khello"</code> to <code>tdevelop/languages/cpp/app_templates/</code> and then add the following files in <code>tdevelop/languages/cpp/app_templates/template-khello/</code> (in this example the language is c++ if you use other language replace cpp with the language name): - - <code>".kdev_ignore"</code> is an empty file. It prevents KDevelop's + - <code>".kdev_ignore"</code> is an empty file. It prevents TDevelop's C++-parser from parsing the C++ template files. This is necessary because the template files are just code templates and not real code (yet). - <code>".cvsignore"</code> looks like this: \code diff --git a/doc/api/HowToAddFileTemplates.dox b/doc/api/HowToAddFileTemplates.dox index fa6e630b..cb9ee17b 100644 --- a/doc/api/HowToAddFileTemplates.dox +++ b/doc/api/HowToAddFileTemplates.dox @@ -14,15 +14,15 @@ source files. Sometimes, different 'flavours' of template are required for a particular file type. In these instances, 'subtypes' can be defined to allow several different templates for a file type. An example -of this are QT designer '.ui' files. KDevelop supplies several different templates for .ui +of this are QT designer '.ui' files. TDevelop supplies several different templates for .ui files. Subtypes are named by the file type extension followed by a hyphen followed by an identifier for the subtype. E.g. ui-widget, ui-dialog The description of the prototypes is placed in <code>parts/filecreate/template-info.xml</code>. This file is fairly self-explanatory if you take a look at it. -Note that templates and templates information can be edited within KDevelop itself. The global -templates that can be made available to any project can be changed in Settings / Configure KDevelop... / New File +Note that templates and templates information can be edited within TDevelop itself. The global +templates that can be made available to any project can be changed in Settings / Configure TDevelop... / New File Wizard; and project related settings can be changed in Project / Project Options / New File Wizard. That's all! :) diff --git a/doc/api/HowToAddGenericBuildTools.dox b/doc/api/HowToAddGenericBuildTools.dox index b073cf0f..ce5d045e 100644 --- a/doc/api/HowToAddGenericBuildTools.dox +++ b/doc/api/HowToAddGenericBuildTools.dox @@ -11,7 +11,7 @@ Build system plugins are located in buildtools/generic/buildsystem. \section sectionStep1 Step 1: Make your plugin loadable -For a plugin <code>foo</code>, create a file <code>foo.desktop</code> which contains KDevelop/Part in its list of ServiceTypes. +For a plugin <code>foo</code>, create a file <code>foo.desktop</code> which contains TDevelop/Part in its list of ServiceTypes. The rest of this document is to be written. diff --git a/doc/api/HowToAddPlugins.dox b/doc/api/HowToAddPlugins.dox index fa7f74e2..012cb5d0 100644 --- a/doc/api/HowToAddPlugins.dox +++ b/doc/api/HowToAddPlugins.dox @@ -1,12 +1,12 @@ /** \file HowToAddPlugins.dox - * \brief How to extend KDevelop via plugins + * \brief How to extend TDevelop via plugins */ -/** \page howToAddPlugins How to extend KDevelop via plugins +/** \page howToAddPlugins How to extend TDevelop via plugins \section createDesktop Step 1: Make your plugin loadable -For a plugin <code>foo</code>, create a file <code>foo.desktop</code> which contains KDevelop/Part in its list of ServiceTypes. +For a plugin <code>foo</code>, create a file <code>foo.desktop</code> which contains TDevelop/Part in its list of ServiceTypes. - See <code>parts/doctreeview/kdevdoctreeview.desktop</code> for an example. . @@ -118,7 +118,7 @@ Take attention to the issue that the project file usually is shared in a team of developers (e.g. via version control application CVS). So some user preferences might be very individual, and some may be valid for all of the team - project-wide so to speak. -That's why the KDevelop architecture makes a difference here and supports two files +That's why the TDevelop architecture makes a difference here and supports two files which will be stored in the project root directory. They are the project file (*.tdevelop) and the session (*.kdevses) file. The later is for individual settings, not to be thought to be shared. @@ -159,7 +159,7 @@ The base class of all TDevelop plugins is KDevPlugin. It provides two virtual me restorePartialProjectSession(..) and savePartialProjectSession(..) that you should reimplement in your special plugin to attach to session loading and saving. -When KDevelop loads or closes a project, the program's project session manager +When TDevelop loads or closes a project, the program's project session manager (class ProjectSession) calls them for each plugin. That manager gives a QDOM node to the plugin where it can read out or build up its partial DOM subtree with the session settings. That subtree will be stored in the .kdevses file by that session manager. diff --git a/doc/api/HowToAddProgrammingLanguages.dox b/doc/api/HowToAddProgrammingLanguages.dox index a5840885..1926d811 100644 --- a/doc/api/HowToAddProgrammingLanguages.dox +++ b/doc/api/HowToAddProgrammingLanguages.dox @@ -4,7 +4,7 @@ /** \page howToAddProgrammingLanguages How to add support for a programming language -\section LSupport List of things to have "complete" support of a given language in KDevelop +\section LSupport List of things to have "complete" support of a given language in TDevelop - Implement interface KDevLanguageSupport - \ref sectionClassWizard @@ -30,12 +30,12 @@ - \ref sectionCompilerPlugins . -List of optional things to support a given language in KDevelop: +List of optional things to support a given language in TDevelop: - \ref sectionEditor - Syntax highlighter - (add to QEditor if not available elsewhere) - \ref sectionBuildTool (make/ant/etc) . -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. +Take a look at \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) to see the current status/features of the programming languages currently supported by TDevelop. @@ -52,8 +52,8 @@ Implementing methods: 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. +TDevelop ships with KDevLang project template. It is a simple language support prototype that can be used when developing language support plugins with TDevelop. +To use it, start a New Project and select: <code>C++->TDevelop->TDevelop Language Support Plugin</code> in the application wizard. The template is located in <code>languages/cpp/app_templates/kdevlang</code>, you can change it there if you need. @@ -93,7 +93,7 @@ See <code>cpp</code> and <code>java</code> for examples. In general, class stores can be filled with information without specialized and complex language parsers (take a look at <code>languages/python</code> that have a very simple python parser) but your language support will surely benefit -from having such. There is a hand-written c/c++ parser (<code>lib/cppparser</code>) in KDevelop that might be used for ObjC or related C-based languages. +from having such. There is a hand-written c/c++ parser (<code>lib/cppparser</code>) in TDevelop that might be used for ObjC or related C-based languages. Other (not so complex as c++) languages can be parsed by ANTLR based parsers (library is in lib/antlr). Consult www.antlr.org for a ANTLR documentation and look at <code>languages/java</code>, <code>languages/ada</code> and <code>languages/pascal</code> for an example of using such parsers. @@ -106,13 +106,13 @@ If you write (or have) a language parser, your language support can have and methods - their names, names of source files, location in source files, etc.). Class store libraries can be found at <code>lib/catalog</code> (Catalog) and <code>lib/interfaces</code> (CodeModel). -KDevelop provides class browsers that extract information from a <b>class store</b> and display it in a tree view and toolbar selectors of scopes, classes and methods. +TDevelop provides class browsers that extract information from a <b>class store</b> and display it in a tree view and toolbar selectors of scopes, classes and methods. \subsubsection sectionMemoryClassStore Memory class store CodeModel is the memory class store. It is very efficient and thus it is recommended for using as a project class store. CodeModel libraries are located in <code>lib/interfaces/codemodel.h</code>. The class browser for a CodeModel based stores is <code>parts/classview</code>. \subsubsection sectionPersistantClassStore Persistant class store -Catalog is the persistant class store for KDevelop. Persistant class store can be used as an information storage for code completion but it also can be used as a class store for the project. Take a look at +Catalog is the persistant class store for TDevelop. Persistant class store can be used as an information storage for code completion but it also can be used as a class store for the project. Take a look at <code>languages/cpp</code> for an example of using catalog. Catalog is stored on disk in the database file (Berkeley db) If you use catalog with the project, your class browser will be <code>parts/classbrowser</code>. \subsection sectionCodeCompletion Code completion @@ -136,12 +136,12 @@ and look at <code>languages/ruby/app_templates/rubyhello</code>, <code>languages \subsubsection sectionApplicationImportTemplates Application import templates -KDevelop has the ability to <b>create a new project from existing projects or source code</b>. +TDevelop has the ability to <b>create a new project from existing projects or source code</b>. It scans for project files ('*.tdevelop, *.kdevprj, *.studio, *.pro) and if - it finds a project it extracts the necessary information - it does not find project files it scans for source files (*.cpp, *.java, *.pl, *.py, ...) . -and creates a new KDevelop project in the direcotry the user has chosen. +and creates a new TDevelop project in the direcotry the user has chosen. \subsubsection sectionSourceFileTemplates Source file templates @@ -153,14 +153,14 @@ Consult FileCreatePart (parts/filecreate/README.dox file) and \ref howToAddFileT \subsubsection sectionAbbreviationTemplates Code abbreviation templates -KDevelop has a support for <b>code abbreviations</b> so you can add some predefined abbreviations to your language support. Take <code>languages/cpp/cpptemplates</code> as an example. +TDevelop has a support for <b>code abbreviations</b> so you can add some predefined abbreviations to your language support. Take <code>languages/cpp/cpptemplates</code> as an example. \subsection sectionSourceCodeFormater Source code formater Implement a KDevSourceFormater class interface. To obtain source formater functionality (that is already available to -c-based languages) you can extend astyle library (<code>lib/astyle</code>) that is used by KDevelop to format sources. +c-based languages) you can extend astyle library (<code>lib/astyle</code>) that is used by TDevelop to format sources. Take a look at AStylePart for an example how to do it. \subsection sectionDocumentationTopics Documentation topics @@ -170,13 +170,13 @@ In the end you need to edit the <code>languages/YOURLANGUAGE/doc/Makefile.am</co \subsection sectionDebugger Debugger -The last thing to have a complete language support in KDevelop is to -write a <b>Debugger </b>. KDevelop already provides GDB support +The last thing to have a complete language support in TDevelop is to +write a <b>Debugger </b>. TDevelop already provides GDB support (<code>languages/cpp/debugger</code>) and JDB (java debugger) support (<code>languages/java/debugger</code>). Take a look at them to get inspiration. \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. +There is an ability to create compiler plugin for TDevelop. Compiler plugin provides the compiler configuration dialog which implements command line compiler options. Compiler plugins must implement KDevCompilerOptions interface. @@ -192,14 +192,14 @@ See also \ref howToAddPlugins (doc/api/HowToAddPlugins.dox file) for an informat \section sectionEditor Language Editor -To edit source files KDevelop uses any editor that supports the KTextEditor +To edit source files TDevelop uses any editor that supports the KTextEditor interface. The current supported editors and their features are listed in the \ref EditorsSupportStatus (doc/api/EditorsSupportStatus.dox file) page. In case none of the editors does support advanced editing of sources written in your language (like code folding, syntax highlighting, line -indentation) you can improve QEditor included in KDevelop (<code>editors/qeditor</code>). -By creating QEditorIndenter and QSourceColorizer descendants you can provide the support for an automatic indentation and syntax highlighting that will be available for sure in KDevelop. +indentation) you can improve QEditor included in TDevelop (<code>editors/qeditor</code>). +By creating QEditorIndenter and QSourceColorizer descendants you can provide the support for an automatic indentation and syntax highlighting that will be available for sure in TDevelop. @@ -209,7 +209,7 @@ By creating QEditorIndenter and QSourceColorizer descendants you can provide the \section sectionBuildTool Build Tool The language support is important, but it is unusable without a <b>build tool</b> -that can manage projects written on this language. KDevelop +that can manage projects written on this language. TDevelop currently provides several build tools. They are: - ANT build tool diff --git a/doc/api/HowToDocument.dox b/doc/api/HowToDocument.dox index d606a8bf..d7fa3680 100644 --- a/doc/api/HowToDocument.dox +++ b/doc/api/HowToDocument.dox @@ -1,13 +1,13 @@ /** \file HowToDocument.dox - * \brief How to document KDevelop parts + * \brief How to document TDevelop parts */ -/** \page howToDocument How to document KDevelop parts +/** \page howToDocument How to document TDevelop parts You should add a README and a README.dox file to your part (KDevPlugin). On the README file put this text: \verbatim -Please read the on-line, automaticaly updated KDevelop API documentation at: +Please read the on-line, automaticaly updated TDevelop API documentation at: http://www.kdevelop.org or read the README.dox file. \endverbatim diff --git a/doc/api/LangSupportStatus.dox b/doc/api/LangSupportStatus.dox index fa08cc67..967bd886 100644 --- a/doc/api/LangSupportStatus.dox +++ b/doc/api/LangSupportStatus.dox @@ -318,7 +318,7 @@ Legend: </tr> <tr> <td>cppparser</td> - <td>New c/c++ parser written by Roberto Raggi for KDevelop</td> + <td>New c/c++ parser written by Roberto Raggi for TDevelop</td> </tr> <tr> <td>Internal</td> diff --git a/doc/api/Mainpage.dox b/doc/api/Mainpage.dox index 262cd2ed..f399fb40 100644 --- a/doc/api/Mainpage.dox +++ b/doc/api/Mainpage.dox @@ -3,24 +3,24 @@ */ /** -\mainpage The KDevelop %API %Documentation +\mainpage The TDevelop %API %Documentation -KDevelop is an easy to use IDE (Integrated Development Environment) for developing applications under X11. +TDevelop is an easy to use IDE (Integrated Development Environment) for developing applications under X11. \section intro Introduction -This document is targeted at all those that want to add or improve KDevelop's source code. -If you are instead looking for a user manual, just go to the help menu of your KDevelop and select KDevelop handbook. -This documentation contains the KDevelop online class reference for the current -development version of KDevelop. Additionally, you +This document is targeted at all those that want to add or improve TDevelop's source code. +If you are instead looking for a user manual, just go to the help menu of your TDevelop and select TDevelop handbook. +This documentation contains the TDevelop online class reference for the current +development version of TDevelop. Additionally, you can subscribe or read the <a href="http://www.kdevelop.org/index.html?filename=mailinglist.html">mailing list</a> for any additions and/or modifications to the %API. An on-line, updated every 24H, html version of this documentation can be found at: http://www.kdevelop.org/HEAD/doc/api/html/index.html -More information about the KDevelop architecture in form of tutorials, HOWTOs, +More information about the TDevelop architecture in form of tutorials, HOWTOs, and FAQs can be found at -the <a href="http://www.kdevelop.org">KDevelop website</a>. +the <a href="http://www.kdevelop.org">TDevelop website</a>. \section status Current Status @@ -29,9 +29,9 @@ Here you can see the current \ref requirements and the \ref features. There is also a \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) page and a \ref EditorsSupportStatus (doc/api/EditorsSupportStatus.dox file) page. -\section expand How to expand KDevelop +\section expand How to expand TDevelop -First of all read the \ref architecture (doc/api/Architecture.dox file) then you can find more information on how to expand KDevelop: +First of all read the \ref architecture (doc/api/Architecture.dox file) then you can find more information on how to expand TDevelop: - \ref howToAddPlugins (doc/api/HowToAddPlugins.dox file) - \ref howToAddProgrammingLanguages (doc/api/HowToAddProgrammingLanguages.dox file) - \ref howToAddApplicationTemplates (doc/api/HowToAddApplicationTemplates.dox file) @@ -49,8 +49,8 @@ Here is a priority ordered list: -# fix the bugs in the \ref bug -# fix the dispersed \ref todo all over the code. . -There are some \ref unmaintained parts in KDevelop. You migth want to "adopt" one. :)\n -There is also \ref FutureTasks (doc/api/FutureTasks.dox file). Put all ideas for the future KDevelop releases there. It is also a good place to comment on those ideas. +There are some \ref unmaintained parts in TDevelop. You migth want to "adopt" one. :)\n +There is also \ref FutureTasks (doc/api/FutureTasks.dox file). Put all ideas for the future TDevelop releases there. It is also a good place to comment on those ideas. \section misc Misc @@ -59,7 +59,7 @@ There is also \ref FutureTasks (doc/api/FutureTasks.dox file). Put all ideas for - \ref FAQ - \ref deprecated -\section misc_libs Miscellaneous libraries included in KDevelop +\section misc_libs Miscellaneous libraries included in TDevelop - \ref PropEditor \section howTobuildAPIlocalcopy How to build a local copy of this documentation diff --git a/doc/api/Makefile.am b/doc/api/Makefile.am new file mode 100644 index 00000000..14b399c7 --- /dev/null +++ b/doc/api/Makefile.am @@ -0,0 +1,3 @@ +DOXYGEN_PROJECTNAME = TDevelop API Documentation +DOXYGEN_DOCDIRPREFIX = kdev +include ../../Doxyfile.am diff --git a/doc/api/PropEditor.dox b/doc/api/PropEditor.dox index 676e634c..40ce4261 100644 --- a/doc/api/PropEditor.dox +++ b/doc/api/PropEditor.dox @@ -1,8 +1,8 @@ /** \file PropEditor.dox - \brief The KDevelop Property Editor library description page + \brief The TDevelop Property Editor library description page */ -/** \page PropEditor KDevelop Property Editor library description +/** \page PropEditor TDevelop Property Editor library description \section whatis What is Property Editor? @@ -10,7 +10,7 @@ properties of an object. For example, look at %Qt Designer. Each widget has a list of properties that can be edited in a nice table form. Same ideology is used to edit properties in Kugar Report Designer -(from KOffice distribution). In KDevelop project manager can also display +(from KOffice distribution). In TDevelop project manager can also display the properties of currently selected build item in property editor. \section over Library Overview diff --git a/doc/platform/Mainpage.dox b/doc/platform/Mainpage.dox index 29f6deb0..764afff3 100644 --- a/doc/platform/Mainpage.dox +++ b/doc/platform/Mainpage.dox @@ -3,10 +3,10 @@ */ /** -\mainpage The KDevelop Platform %API %Documentation +\mainpage The TDevelop Platform %API %Documentation -KDevelop Platform is set of libraries and tools that are used to build IDEs (Integrated Development Environments), +TDevelop Platform is set of libraries and tools that are used to build IDEs (Integrated Development Environments), applications similar to IDEs (web development enviroment, text editors for programmers and designers, etc.) and/or IDE plugins for all possible purposes. @@ -18,10 +18,10 @@ Platform provides: \section intro Introduction -This document is targeted at all those that want to build their own IDE or improve KDevelop's source code. -If you are instead looking for a user manual, just go to the help menu of your KDevelop and select KDevelop handbook. -This documentation contains the KDevelop Platform online class reference for the current -development version of KDevelop. Additionally, you +This document is targeted at all those that want to build their own IDE or improve TDevelop's source code. +If you are instead looking for a user manual, just go to the help menu of your TDevelop and select TDevelop handbook. +This documentation contains the TDevelop Platform online class reference for the current +development version of TDevelop. Additionally, you can subscribe or read the <a href="http://www.kdevelop.org/index.html?filename=mailinglist.html">mailing list</a> for any additions and/or modifications to the Platform %API. @@ -29,12 +29,12 @@ An on-line, updated every 24H, html version of this documentation can be found a You can also download a local browseable copy form http://www.kdevelop.org/HEAD/doc/platform/kdevplatformdoc.tar.bz2 . It gets updated every single day too. -More information about the KDevelop Platform architecture in form of tutorials, Wikis, HOWTOs, +More information about the TDevelop Platform architecture in form of tutorials, Wikis, HOWTOs, and FAQs can be found at -the <a href="http://www.kdevelop.org">KDevelop website</a>. +the <a href="http://www.kdevelop.org">TDevelop website</a>. Quick overviews of the architecture can also be found in the issues of <a href="http://www.kdevelop.org/doc/tehcnotes"> -KDevelop Technotes</a>. +TDevelop Technotes</a>. \section platformapi Platform Libraries API @@ -46,7 +46,7 @@ KDevelop Technotes</a>. <i>Extension interfaces used by TDevelop plugin architecture.</i> - <a href="kdevutil/html/index.html"><b>Utility Library</b></a> (<a href="kdevutil/html/classes.html">classes</a>)\n - <i>Utility classes for the KDevelop architecture.</i> + <i>Utility classes for the TDevelop architecture.</i> - <a href="kdevextras/html/index.html"><b>Extra Interfaces Library</b></a> (<a href="kdevextras/html/classes.html">classes</a>)\n <i>Extra interfaces that are not the part of TDevelop plugin architecture @@ -76,14 +76,14 @@ KDevelop Technotes</a>. - <a href="kdevdocinterfaces/html/index.html"><b>Documentation Part Interfaces Library</b></a> (<a href="kdevdocinterfaces/html/classes.html">classes</a>)\n - <i>Interfaces to implement KDevelop documentation plugins.</i> + <i>Interfaces to implement TDevelop documentation plugins.</i> . \section langapi Programming Language Support API - <a href="kdevlanginterfaces/html/index.html"><b>Language Support Interfaces Library</b></a> (<a href="kdevlanginterfaces/html/classes.html">classes</a>)\n - <i>Interfaces for KDevelop language support facilities.</i> + <i>Interfaces for TDevelop language support facilities.</i> - <a href="kdevlangdebugger/html/index.html"><b>Debugger Support Library</b></a> (<a href="kdevlangdebugger/html/classes.html">classes</a>)\n <i>Classes to implement debugger support for a programming language.</i> @@ -93,10 +93,10 @@ KDevelop Technotes</a>. - <a href="kdevbtbase/html/index.html"><b>Buildtool Base Library</b></a> (<a href="kdevbtbase/html/classes.html">classes</a>)\n - <i>Base classes for KDevelop builtool support plugins.</i> + <i>Base classes for TDevelop builtool support plugins.</i> - <a href="kdevpminterfaces/html/index.html"><b>Project Manager Interfaces Library</b></a> (<a href="kdevpminterfaces/html/classes.html">classes</a>)\n - <i>Interfaces to implement plugins for the KDevelop generic project manager.</i> + <i>Interfaces to implement plugins for the TDevelop generic project manager.</i> - <a href="kdevbtwidgets/html/index.html"><b>Buildtool Widgets Library</b></a> (<a href="kdevbtwidgets/html/classes.html">classes</a>)\n <i>Widgets commonly used in buildtool support plugins.</i> @@ -129,7 +129,7 @@ Here is a priority ordered list: \section howTobuildAPIlocalcopy How to build a local copy of this documentation This documentation is large and changes with every cvs commit, therefore is not available for download. -To build your local copy of this documentation you need to fetch KDevelop sources and +To build your local copy of this documentation you need to fetch TDevelop sources and if you have doxygen >= 1.3.4 and (optionally) PHP >= 4.10 plus a local running webserver then - make apidox - make install-apidox (as root) diff --git a/doc/std/kdev3api.toc b/doc/std/kdev3api.toc index ef1c82dc..8d0de47f 100644 --- a/doc/std/kdev3api.toc +++ b/doc/std/kdev3api.toc @@ -1,45 +1,56 @@ <!DOCTYPE tdeveloptoc> <tdeveloptoc> -<title>KDevelop API Documentation</title> -<base href="http://www.kdevelop.org/HEAD/doc/api/html"/> -<tocsect1 name="Overview" url="index.html"> - <tocsect2 name="KDevelop 3 Architecture" url="KDev3Arch.html"/> - <tocsect2 name="Programming Languages Status" url="LangSupportStatus.html"/> - <tocsect2 name="Editors Status" url="EditorsSupportStatus.html"/> -</tocsect1> -<tocsect1 name="How to" url="index.html#expand"> - <tocsect2 name="Extend KDevelop via plugins" url="howToAddPlugins.html"/> - <tocsect2 name="Add a programming language" url="howToAddProgrammingLanguages.html"/> - <tocsect2 name="Add application templates" url="howToAddApplicationTemplates.html"/> - <tocsect2 name="Add file templates" url="howToAddFileTemplates.html"/> - <tocsect2 name="Add generic build tools" url="howToAddGenericBuildTools.html"/> - <tocsect2 name="Document KDevelop parts" url="howToDocument.html"/> -</tocsect1> -<tocsect1 name="Planned tasks" url="index.html#PlannedTasks"> - <tocsect2 name="High priority tasks!" url="HighPriTasks.html"/> - <tocsect2 name="Future Tasks!" url="FutureTasks.html"/> -</tocsect1> -<tocsect1 name="Class Hierarchy" url="hierarchy.html"> -</tocsect1> -<tocsect1 name="Classes" url="classes.html"> -</tocsect1> -<tocsect1 name="Classes (annotated)" url="annotated.html"> -</tocsect1> -<tocsect1 name="Members" url="functions.html"> -</tocsect1> -<tocsect1 name="Namespaces" url="namespaces.html"> -</tocsect1> -<tocsect1 name="Source Files" url="files.html"> -</tocsect1> -<tocsect1 name="README.dox" url="index.html#misc"> - <tocsect2 name="Requirements" url="requirements.html"/> - <tocsect2 name="Features" url="features.html"/> - <tocsect2 name="Authors" url="authors.html"/> - <tocsect2 name="Maintainers" url="maintainers.html"/> - <tocsect2 name="Unmaintained parts" url="unmaintained.html"/> - <tocsect2 name="Deprecated List" url="deprecated.html"/> - <tocsect2 name="Todo List" url="todo.html"/> - <tocsect2 name="Known Bugs" url="bug.html"/> - <tocsect2 name="F.A.Q." url="FAQ.html"/> -</tocsect1> +<title>TDevelop API Documentation (local docs)</title> +<base href="file:///opt/trinity/share/doc/tde/HTML/en/tdevelop-apidocs"/> + +<tocsect1 name="Introduction" url="doc/api/html/index.html"> + <tocsect2 name="TDevelop 3 Architecture" url="doc/api/html/architecture.html"/> + <tocsect2 name="Programming Languages Status" url="doc/api/html/LangSupportStatus.html"/> + <tocsect2 name="Editors Status" url="doc/api/html/EditorsSupportStatus.html"/> +</tocsect1> +<tocsect1 name="How to" url="doc/api/html/index.html#expand"> + <tocsect2 name="Extend TDevelop via plugins" url="doc/api/html/howToAddPlugins.html"/> + <tocsect2 name="Add a programming language" url="doc/api/html/howToAddProgrammingLanguages.html"/> + <tocsect2 name="Add application templates" url="doc/api/html/howToAddApplicationTemplates.html"/> + <tocsect2 name="Add file templates" url="doc/api/html/howToAddFileTemplates.html"/> + <tocsect2 name="Add generic build tools" url="doc/api/html/howToAddGenericBuildTools.html"/> + <tocsect2 name="Document TDevelop parts" url="doc/api/html/howToDocument.html"/> +</tocsect1> +<tocsect1 name="Planned tasks" url="doc/api/html/index.html#PlannedTasks"> + <tocsect2 name="High priority tasks!" url="doc/api/html/HighPriTasks.html"/> + <tocsect2 name="Future Tasks!" url="doc/api/html/FutureTasks.html"/> +</tocsect1> +<tocsect1 name="Libraries Reference" url="index.html"> + <tocsect2 name="Buildtool Support" url="index.html"> + <tocsect3 name="Buildtool Base Library" url="buildtools/lib/base/html/index.html"/> + <tocsect3 name="Buildtool Widgets Library" url="buildtools/lib/widgets/html/index.html"/> + <tocsect3 name="AutoTools Parser Library" url="buildtools/lib/parsers/autotools/html/index.html"/> + <tocsect3 name="QMake Parser Library" url="buildtools/lib/parsers/qmake/html/index.html"/> + </tocsect2> + <tocsect2 name="GUI Designer Integration" url="index.html"> + <tocsect3 name="KInterfaceDesigner Library" url="lib/interfaces/external/html/index.html"/> + <tocsect3 name="Designer Integration Support Library" url="languages/lib/designer_integration/html/index.html"/> + </tocsect2> + <tocsect2 name="Platform Libraries" url="index.html"> + <tocsect3 name="Interfaces Library" url="lib/interfaces/html/index.html"/> + <tocsect3 name="Extension Interfaces Library" url="lib/interfaces/extensions/html/index.html"/> + <tocsect3 name="Extra Interfaces Library" url="lib/interfaces/extras/html/index.html"/> + <tocsect3 name="Utility Library" url="lib/util/html/index.html"/> + <tocsect3 name="Widgets Library" url="lib/widgets/html/index.html"/> + <tocsect3 name="Property Editing Library" url="lib/widgets/propeditor/html/index.html"/> + <tocsect3 name="Catalog Library" url="lib/catalog/html/index.html"/> + </tocsect2> + <tocsect2 name="Platform Plugins" url="index.html"> + <tocsect3 name="Documentation Part Interfaces Library" url="parts/documentation/interfaces/html/index.html"/> + </tocsect2> + <tocsect2 name="Programming Language Support" url="index.html"> + <tocsect3 name="Language Support Interfaces Library" url="languages/lib/interfaces/html/index.html"/> + <tocsect3 name="Debugger Support Library" url="languages/lib/debugger/html/index.html"/> + </tocsect2> + <tocsect2 name="Shell" url="index.html"> + <tocsect3 name="Generic Shell Library" url="src/html/index.html"/> + <tocsect3 name="Shell Profiles Library" url="src/profileengine/lib/html/index.html"/> + </tocsect2> +</tocsect1> + </tdeveloptoc> diff --git a/editors/editor-chooser/README.dox b/editors/editor-chooser/README.dox index 4dea700d..cefdaedf 100644 --- a/editors/editor-chooser/README.dox +++ b/editors/editor-chooser/README.dox @@ -1,8 +1,8 @@ /** \class EditorChooserPart -Chooses the text editor to use in KDevelop from a list of all KTextEditor Class interface compliant editors installed in KDE. +Chooses the text editor to use in TDevelop from a list of all KTextEditor Class interface compliant editors installed in KDE. \authors <a href="mailto:hoelzer AT physik.uni-wuerzburg.de">Matthias Hoelzer</a> -\feature Chooses the text editor to use in KDevelop from a list of all KTextEditor Class interface compliant editors installed in KDE. +\feature Chooses the text editor to use in TDevelop from a list of all KTextEditor Class interface compliant editors installed in KDE. */ diff --git a/languages/cpp/README.dox b/languages/cpp/README.dox index 460c4cc7..7e9e0fd5 100644 --- a/languages/cpp/README.dox +++ b/languages/cpp/README.dox @@ -1,5 +1,5 @@ /** \class CppSupportPart -Provides C/C++ language support for KDevelop. +Provides C/C++ language support for TDevelop. 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.* diff --git a/languages/lib/debugger/Mainpage.dox b/languages/lib/debugger/Mainpage.dox index 5d8b3f2e..90c16a2a 100644 --- a/languages/lib/debugger/Mainpage.dox +++ b/languages/lib/debugger/Mainpage.dox @@ -1,5 +1,5 @@ /** -@mainpage The KDevelop %Debugger Support Library +@mainpage The TDevelop %Debugger Support Library This library contains classes to implement debugger support for a programming language. diff --git a/languages/lib/designer_integration/Mainpage.dox b/languages/lib/designer_integration/Mainpage.dox index 1f2db949..8f114046 100644 --- a/languages/lib/designer_integration/Mainpage.dox +++ b/languages/lib/designer_integration/Mainpage.dox @@ -1,5 +1,5 @@ /** -@mainpage The KDevelop Designer Integration Support Library +@mainpage The TDevelop Designer Integration Support Library This library contains base classes to implement GUI designer integration in language support plugins. diff --git a/languages/lib/interfaces/Mainpage.dox b/languages/lib/interfaces/Mainpage.dox index c8cd98b7..09d235df 100644 --- a/languages/lib/interfaces/Mainpage.dox +++ b/languages/lib/interfaces/Mainpage.dox @@ -1,7 +1,7 @@ /** -@mainpage The KDevelop Language Support Interfaces Library +@mainpage The TDevelop Language Support Interfaces Library -This library contains interfaces for KDevelop language support facilities. +This library contains interfaces for TDevelop language support facilities. <b>Link with</b>: -llang_interfaces diff --git a/languages/pascal/README.dox b/languages/pascal/README.dox index 52ef50b1..d41ad832 100644 --- a/languages/pascal/README.dox +++ b/languages/pascal/README.dox @@ -19,7 +19,7 @@ with the one from <a href="ftp://fara.cs.uni-potsdam.de/incoming/CppCodeGenerato \bug Language parser can sometimes treat correct lines as errors. Please send sample code to maintainer if you have this problem. -\faq <b>Why KDevelop does not provide GNU pascal compiler plugin?</b> If you need GNU pascal compiler plugin, please write about it to maintainer and prepare to help testing it. +\faq <b>Why TDevelop does not provide GNU pascal compiler plugin?</b> If you need GNU pascal compiler plugin, please write about it to maintainer and prepare to help testing it. \faq <b>Compiler plugin lacks option X.</b> Write about it to maintaner or send a patch. Adding compiler options is easy task. Just look at languages/pascal/compiler directory. diff --git a/lib/interfaces/external/Mainpage.dox b/lib/interfaces/external/Mainpage.dox index 4ed571dd..8c22ba73 100644 --- a/lib/interfaces/external/Mainpage.dox +++ b/lib/interfaces/external/Mainpage.dox @@ -26,7 +26,7 @@ KInterfaceDesigner::Designer interface): void editFunction(DesignerType type, const QString &formName, const QString &functionName) void editSource(DesignerType type, const QString &formName); @endcode -are connected to corresponding Q_SLOTS of TDevelop designer integration engine which can be implemented in KDevelop language support plugin. +are connected to corresponding Q_SLOTS of TDevelop designer integration engine which can be implemented in TDevelop language support plugin. Each language support which wants to use integrated designer, must reimplement @code @@ -39,8 +39,8 @@ developers. With the convenience library writing %Qt designer integration for th trivial task. -\section kdevdesigner KDevelop Designer technical overview -KDevelop version >= 3.1 comes with a customized version (fork ;)) of %Qt Designer. It is called KDevelop Designer (KDevDesigner, kdevdesigner from the command line). KDevDesigner has some important differences: +\section kdevdesigner TDevelop Designer technical overview +TDevelop version >= 3.1 comes with a customized version (fork ;)) of %Qt Designer. It is called TDevelop Designer (KDevDesigner, kdevdesigner from the command line). KDevDesigner has some important differences: - KDevDesigner provides a read/write KPart which can be embedded into any application which wants to edit .ui files. TDevelop IDE embeds KDevDesigner this way. - KDevDesigner uses %KDE icons and dialogs and thus provides better integration with a system. . diff --git a/lib/util/Mainpage.dox b/lib/util/Mainpage.dox index 7cd0974c..e28aa430 100644 --- a/lib/util/Mainpage.dox +++ b/lib/util/Mainpage.dox @@ -1,7 +1,7 @@ /** -@mainpage The KDevelop Utility Library +@mainpage The TDevelop Utility Library -This library contains utility classes for the KDevelop architecture. +This library contains utility classes for the TDevelop architecture. <b>Link with</b>: -ltdevelop diff --git a/lib/widgets/Mainpage.dox b/lib/widgets/Mainpage.dox index 1208c02f..b3854054 100644 --- a/lib/widgets/Mainpage.dox +++ b/lib/widgets/Mainpage.dox @@ -1,5 +1,5 @@ /** -@mainpage The KDevelop Widgets Library +@mainpage The TDevelop Widgets Library This library contains a collection of widgets. diff --git a/lib/widgets/propeditor/Mainpage.dox b/lib/widgets/propeditor/Mainpage.dox index 9a3a741a..d77010d0 100644 --- a/lib/widgets/propeditor/Mainpage.dox +++ b/lib/widgets/propeditor/Mainpage.dox @@ -1,5 +1,5 @@ /** -@mainpage The KDevelop Property Editing Library +@mainpage The TDevelop Property Editing Library <b>Link with</b>: -ltdevelop @@ -12,7 +12,7 @@ properties of an object. For example, look at %Qt Designer. Each widget has a list of properties that can be edited in a nice table form. Same ideology is used to edit properties in Kugar Report Designer -(from KOffice distribution). In KDevelop project manager can also display +(from KOffice distribution). In TDevelop project manager can also display the properties of currently selected build item in property editor. \section over Library Overview diff --git a/parts/appwizard/README.dox b/parts/appwizard/README.dox index 3da524ab..2e58c082 100644 --- a/parts/appwizard/README.dox +++ b/parts/appwizard/README.dox @@ -61,7 +61,7 @@ Qt Qt based Kicker Kicker applet tdeioslave KDE ioslave KOffice KOffice application -KDevelop TDevelop plugin +TDevelop TDevelop plugin GNOME GNOME application \endverbatim diff --git a/parts/diff/README.dox b/parts/diff/README.dox index 6659ac71..65e04fbc 100644 --- a/parts/diff/README.dox +++ b/parts/diff/README.dox @@ -13,7 +13,7 @@ and select "diff to repository" to see it in action. \feature Shows "diffs" between files \feature If "kompare" from KDESDK is installed, it'll use its widget to display the diff otherwise in a QTextEdit with simple highlighting -\feature Works with all VCS systems supported by KDevelop +\feature Works with all VCS systems supported by TDevelop \requirement If "kompare" from KDESDK is installed, it'll use its widget to display the diff. diff --git a/parts/documentation/README.dox b/parts/documentation/README.dox index b65f0d2a..079ca6e5 100644 --- a/parts/documentation/README.dox +++ b/parts/documentation/README.dox @@ -1,5 +1,5 @@ /** \class Documentation -Documentation plugin for KDevelop. +Documentation plugin for TDevelop. \authors <a href="mailto:cloudtemple@mksat.net">Alexander Dymo</a> @@ -8,7 +8,7 @@ Documentation plugin for KDevelop. \feature Qt API browsing \feature KDE API browsing \feature Devhelp books browsing (GTK/GNOME API) -\feature KDevelopTOC browsing +\feature TDevelopTOC browsing \bug bugs in <a href="http://bugs.kde.org/buglist.cgi?product=tdevelop&component=documentation& bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Bug+Number"> diff --git a/parts/documentation/interfaces/Mainpage.dox b/parts/documentation/interfaces/Mainpage.dox index 5a6bb2bb..050b68d9 100644 --- a/parts/documentation/interfaces/Mainpage.dox +++ b/parts/documentation/interfaces/Mainpage.dox @@ -1,7 +1,7 @@ /** -@mainpage The KDevelop Documentation Part Interfaces Library +@mainpage The TDevelop Documentation Part Interfaces Library -This library contains interfaces to implement KDevelop documentation plugins. +This library contains interfaces to implement TDevelop documentation plugins. <b>Link with</b>: -ldocumentation_interfaces 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". diff --git a/parts/fullscreen/README.dox b/parts/fullscreen/README.dox index 10f74509..2921396f 100644 --- a/parts/fullscreen/README.dox +++ b/parts/fullscreen/README.dox @@ -1,10 +1,10 @@ /** \class FullScreenPart -Displays KDevelop in full screen +Displays TDevelop in full screen \authors <a href="mailto:roberto AT kdevelop.org">Roberto Raggi</a> \maintainer <a href="mailto:roberto AT kdevelop.org">Roberto Raggi</a> -\feature Displays KDevelop in full screen +\feature Displays TDevelop in full screen */ diff --git a/parts/grepview/README.dox b/parts/grepview/README.dox index fe77cd38..ef1875c6 100644 --- a/parts/grepview/README.dox +++ b/parts/grepview/README.dox @@ -1,5 +1,5 @@ /** \class GrepViewPart -Integrates "find|grep" in KDevelop - allows fast searching of multiple files using patterns or regular expressions. +Integrates "find|grep" in TDevelop - allows fast searching of multiple files using patterns or regular expressions. \authors <a href="mailto:bernd AT kdevelop.org">Bernd Gehrmann</a> diff --git a/parts/snippet/README.dox b/parts/snippet/README.dox index 4d5d80de..3cc3ccd0 100644 --- a/parts/snippet/README.dox +++ b/parts/snippet/README.dox @@ -1,5 +1,5 @@ /** \class SnippetPart -This plugin provides a tool view for CodeSnippets which can be easily inserted into any KDevelop sourcecode file. +This plugin provides a tool view for CodeSnippets which can be easily inserted into any TDevelop sourcecode file. \authors <a href="mailto:rgruber@users.sourceforge.net">Robert Gruber</a> diff --git a/parts/tipofday/README.dox b/parts/tipofday/README.dox index f953e258..eaea2270 100644 --- a/parts/tipofday/README.dox +++ b/parts/tipofday/README.dox @@ -1,8 +1,8 @@ /** \class TipOfDayPart -Shows a random "tip of the day" at KDevelop startup. +Shows a random "tip of the day" at TDevelop startup. \authors <a href="mailto:bernd AT kdevelop.org">Bernd Gehrmann</a> -\feature Shows a random "tip of the day" at KDevelop startup +\feature Shows a random "tip of the day" at TDevelop startup */ diff --git a/parts/uimode/README.dox b/parts/uimode/README.dox index 5836e21f..5ed282bf 100644 --- a/parts/uimode/README.dox +++ b/parts/uimode/README.dox @@ -1,8 +1,8 @@ /** \class UIChooserPart -Allows you to choose the KDevelop UImode (Graphical User Interface mode) +Allows you to choose the TDevelop UImode (Graphical User Interface mode) \authors <a href="mailto:hoelzer AT physik.uni-wuerzburg.de">Matthias Hoelzer</a> -\feature Allows you to choose the KDevelop UImode (Graphical User Interface mode) +\feature Allows you to choose the TDevelop UImode (Graphical User Interface mode) */ diff --git a/parts/valgrind/README.dox b/parts/valgrind/README.dox index d5e79fd4..0147a8fb 100644 --- a/parts/valgrind/README.dox +++ b/parts/valgrind/README.dox @@ -11,7 +11,7 @@ Valgrind is a tool that helps you find memory management problems in programs. h ... \maintainer <a href="mailto:nth maintainer AT provider.com">nth maintainer full name</a> -\feature Integrates Valgrind into KDevelop +\feature Integrates Valgrind into TDevelop \bug Describe a the 1st bug that you know of, but probably hasn't been reported yet. .. diff --git a/src/Mainpage.dox b/src/Mainpage.dox index 2f055d1b..8b5a020c 100644 --- a/src/Mainpage.dox +++ b/src/Mainpage.dox @@ -1,5 +1,5 @@ /** -@mainpage The KDevelop Generic Shell +@mainpage The TDevelop Generic Shell This library contains the Shell - a profile-based implementation of TDevelop plugin architecture. @@ -8,7 +8,7 @@ This library contains the Shell - a profile-based implementation of TDevelop plu <b>Include path</b>: -I\$(kde_includes)/tdevelop/shell \section creatingapp Creating an application using generic shell -KDevelop platform applications can use generic shell as a ready to use implementation +TDevelop platform applications can use generic shell as a ready to use implementation of TDevelop plugin architecture. This is done by creating application %main.cpp file and @ref ShellExtension subclass. diff --git a/src/profileengine/lib/Mainpage.dox b/src/profileengine/lib/Mainpage.dox index eb242dd9..d82dee69 100644 --- a/src/profileengine/lib/Mainpage.dox +++ b/src/profileengine/lib/Mainpage.dox @@ -1,5 +1,5 @@ /** -@mainpage The KDevelop Shell Profiles Library +@mainpage The TDevelop Shell Profiles Library This library contains plugin profiles engine for TDevelop shell. diff --git a/vcs/clearcase/README.dox b/vcs/clearcase/README.dox index 74f2678b..47741ab6 100644 --- a/vcs/clearcase/README.dox +++ b/vcs/clearcase/README.dox @@ -1,5 +1,5 @@ /** \class ClearcasePart -Integrates Clearcase configuration management system into KDevelop. +Integrates Clearcase configuration management system into TDevelop. Based on Perforce (PerforcePart) implementation by Harald Fernengel <harry AT kdevelop.org> To use clearcase functions, you need to: @@ -31,7 +31,7 @@ To use clearcase functions, you need to: \authors <a href="mailto:pnoffke AT bigpond dot com">Patrick Noffke</a> \authors <a href="mailto:phil AT hetroy dot org">Philippe Hétroy</a> -\feature Integrates Clearcase configuration management system into KDevelop and displays VCS file information +\feature Integrates Clearcase configuration management system into TDevelop and displays VCS file information \feature Detects the clearcase environment and activates menus \feature Provided a dialog for checkout and checkin comments. diff --git a/vcs/perforce/README.dox b/vcs/perforce/README.dox index 5a2d3756..a9c0ee6e 100644 --- a/vcs/perforce/README.dox +++ b/vcs/perforce/README.dox @@ -1,5 +1,5 @@ /** \class PerforcePart -Integrates the perforce version managment system into KDevelop. +Integrates the perforce version managment system into TDevelop. \authors <a href="mailto:bernd AT kdevelop.org">Bernd Gehrmann</a> Copyright (C) 1999-2001 \authors <a href="mailto:harry AT kdevelop.org">Harald Fernengel</a> Copyright (C) 2002-2003 diff --git a/vcs/subversion/README.dox b/vcs/subversion/README.dox index c463a997..91e40d37 100644 --- a/vcs/subversion/README.dox +++ b/vcs/subversion/README.dox @@ -1,11 +1,11 @@ /** \class subversionPart -Integrates the SVN (Subversion) version management system into KDevelop. +Integrates the SVN (Subversion) version management system into TDevelop. \authors <a href="mailto:marchand AT kde.org">Mickael Marchand</a> \maintainer <a href="mailto:marchand AT kde.org">Mickael Marchand</a> -\feature Integrates the SVN (Subversion) version management system into KDevelop. +\feature Integrates the SVN (Subversion) version management system into TDevelop. \requirement You need to compile and install tdesdk/tdeioslave/svn |