From a93c19aaac4a8bdd50dcf36b372932e7145097f2 Mon Sep 17 00:00:00 2001 From: tpearson Date: Sat, 18 Sep 2010 20:35:25 +0000 Subject: [PATCH] All documentation references to KDE should now be converted to Trinity for the new API website git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1176842 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- Mainpage.dox | 84 +++++++++++++++++++-------------------- dcop/Mainpage.dox | 10 ++--- dnssd/Mainpage.dox | 2 +- kconf_update/Mainpage.dox | 2 +- kdecore/Mainpage.dox | 22 +++++----- kded/Mainpage.dox | 10 ++--- kdefx/Mainpage.dox | 6 +-- kdesu/Mainpage.dox | 2 +- kdeui/Mainpage.dox | 4 +- kdoctools/Mainpage.dox | 4 +- khtml/Mainpage.dox | 2 +- kinit/Mainpage.dox | 4 +- kio/Mainpage.dox | 10 ++--- kjs/Mainpage.dox | 2 +- knewstuff/Mainpage.dox | 4 +- kparts/Mainpage.dox | 4 +- krandr/Mainpage.dox | 2 +- 17 files changed, 86 insertions(+), 88 deletions(-) diff --git a/Mainpage.dox b/Mainpage.dox index d4bff9965..a1a4cf92f 100644 --- a/Mainpage.dox +++ b/Mainpage.dox @@ -4,77 +4,77 @@ * This section contains the Trinity online class reference for the current * development version of Trinity. You can also * download the complete API documentation from - * trinity.pearsoncomputing.net. Additionally, you + * trinity.pearsoncomputing.net. Additionally, you * can subscribe or read the mailing lists for any additions and/or * modifications to the API. * - * - kdecore - * (classes)\n + * - kdecore + * (classes)\n * Core Trinity classes that are not related to the user interface. - * - kdeui - * (classes)\n + * - kdeui + * (classes)\n * Trinity User interface classes such as widgets. - * - khtml - * (classes)\n + * - khtml + * (classes)\n * The Trinity HTML component. - * - kjs - * (classes)\n + * - kjs + * (classes)\n * Javascript (aka. ECMAScript and JScript) support. - * - kio - * (classes)\n + * - kio + * (classes)\n * Low level access to network files. Also provides access to facilities * such as KDirWatcher which monitors directories for changes. - * - kparts - * (classes)\n + * - kparts + * (classes)\n * Support for re-usable, embeddable, extendable applications. - * - dcop - * (classes)\n + * - dcop + * (classes)\n * The DCOP communications library. - * - kdefx - * (classes)\n + * - kdefx + * (classes)\n * A library with pixmap effects. - * - kmdi - * (classes)\n + * - kmdi + * (classes)\n * MultiDocument Interface library. - * - libkmid - * (classes)\n + * - libkmid + * (classes)\n * Midi library. - * - kdeprint - * (classes)\n + * - kdeprint + * (classes)\n * High level printer control functionality. - * - krandr - * (classes)\n + * - krandr + * (classes)\n * High level Xorg configuration via XRandr. - * - interfaces - * (classes)\n + * - interfaces + * (classes)\n * Defines interfaces for common components so that new implementations * can be dropped in. - * - kabc - * (classes)\n + * - kabc + * (classes)\n * Access to the Trinity address book. - * - kresources - * (classes)\n + * - kresources + * (classes)\n * The Trinity resources system. - * - kutils - * (classes)\n + * - kutils + * (classes)\n * High-level utils, like search/replace support. - * - arts - * (classes)\n + * - arts + * (classes)\n * Trinity bindings for arts including knotify. - * - knewstuff - * (classes)\n + * - knewstuff + * (classes)\n * Upload and download of application data. - * - dnssd - * (classes)\n + * - dnssd + * (classes)\n * Network sevices publishing and discovery. - * - kunittest - * (classes)\n + * - kunittest + * (classes)\n * Unit testing framework in Trinity. * * More information about the Trinity architecture in form of tutorials, HOWTOs, * and FAQs can be found at - * the the Trinity project. + * the the Trinity project. */ /** diff --git a/dcop/Mainpage.dox b/dcop/Mainpage.dox index af4f14ec3..d573b01b5 100644 --- a/dcop/Mainpage.dox +++ b/dcop/Mainpage.dox @@ -11,7 +11,7 @@ Either unix domain sockets or TCP/IP sockets are supported. DCOP is built on top of the Inter Client Exchange (ICE) protocol, which comes standard as a part of X11R6 and later. It also depends on Qt, but beyond that it does not require any other libraries. Because of this, -it is extremely lightweight, enabling it to be linked into all KDE +it is extremely lightweight, enabling it to be linked into all Trinity applications with low overhead. \section model Model: @@ -270,7 +270,7 @@ class MyInterface : virtual public DCOPObject As you can see, you're essentially declaring an abstract base class, which virtually inherits from DCOPObject. -If you're using the standard KDE build scripts, then you can simply +If you're using the standard Trinity build scripts, then you can simply add this file (which you would call MyInterface.h) to your sources directory. Then you edit your Makefile.am, adding 'MyInterface.skel' to your SOURCES list and MyInterface.h to include_HEADERS. @@ -551,7 +551,7 @@ stream << pid; kapp->dcopClient()->emitDCOPSignal("clientDied(pid_t)", params); \endcode -The task manager of the KDE panel connects to this signal. It uses an +The task manager of the Trinity panel connects to this signal. It uses an anonymous connection (it doesn't require that the signal is being emitted by KLauncher) that is non-volatile: @@ -570,7 +570,7 @@ a clientDied(void) DCOP function. \section conclusion Conclusion: Hopefully this document will get you well on your way into the world of -inter-process communication with KDE! Please direct all comments and/or -suggestions to the KDE Core Developers List \. +inter-process communication with Trinity! Please direct all comments and/or +suggestions to the Trinity Core Developers List \. */ diff --git a/dnssd/Mainpage.dox b/dnssd/Mainpage.dox index 76b0c1f9b..81ab7c98b 100644 --- a/dnssd/Mainpage.dox +++ b/dnssd/Mainpage.dox @@ -33,7 +33,7 @@ Jakub Stachowski */ -// KDE5: get rid of kdeui reference when settings.kcfgc is changed +// Trinity5: get rid of kdeui reference when settings.kcfgc is changed // DOXYGEN_REFERENCES = kdecore kdeui // DOXYGEN_SET_PROJECT_NAME = DNSSD // DOXYGEN_SET_EXCLUDE_PATTERNS += */dnssd/avahi* */dnssd/mdnsd* diff --git a/kconf_update/Mainpage.dox b/kconf_update/Mainpage.dox index 77d486cea..9db5adb3b 100644 --- a/kconf_update/Mainpage.dox +++ b/kconf_update/Mainpage.dox @@ -16,7 +16,7 @@ several drawbacks: kconf_update addresses these problems by offering a framework to update configuration files without adding code to the application itself. -See the README file for more information. +See the README file for more information. @authors Waldo Bastian \ diff --git a/kdecore/Mainpage.dox b/kdecore/Mainpage.dox index 338b27ae5..fea4b533a 100644 --- a/kdecore/Mainpage.dox +++ b/kdecore/Mainpage.dox @@ -1,18 +1,18 @@ -/** \mainpage The KDE Core Library +/** \mainpage The Trinity Core Library -All KDE programs use this library to provide basic functionality such +All Trinity programs use this library to provide basic functionality such as the configuration system, IPC, internationalization and locale support, site-independent access to the filesystem and a large number of other (but no less important) things.

-All KDE applications should link to the kdecore library. Also, using a -KApplication derived class instead of QApplication is almost +All Trinity applications should link to the kdecore library. Also, using a +KApplication derived class instead of TQApplication is almost mandatory if you expect your application to behave nicely within the -KDE environment. +Trinity environment. If you are unsure where to start, have a look at the -tutorials on -TechBase to get you going. +tutorials on +the Trinity project site to get you going. If you know what you are looking for, you should be able to find it in the class list or the @@ -22,9 +22,7 @@ the class list or the Various: see copyrights on individual files for more information @maintainers -See the -MAINTAINERS -file. +See the MAINTAINERS file. @licenses Library: @lgpl
@@ -34,11 +32,11 @@ Some helper utilities: @gpl /** -\defgroup KDEMacros KDE Macros +\defgroup TrinityMacros Trinity Macros */ // DOXYGEN_EXCLUDE = malloc kde_file.h // DOXYGEN_SET_INPUT += @topdir@/kdemacros.h.cmake -// DOXYGEN_SET_PROJECT_NAME = KDECore +// DOXYGEN_SET_PROJECT_NAME = TrinityCore // vim:ts=4:sw=4:expandtab:filetype=doxygen diff --git a/kded/Mainpage.dox b/kded/Mainpage.dox index f22116add..47f010f9d 100644 --- a/kded/Mainpage.dox +++ b/kded/Mainpage.dox @@ -1,11 +1,11 @@ -/** @mainpage The KDE Daemon +/** @mainpage The Trinity Daemon -KDED runs in the background and performs a number of small tasks. Some +TrinityD runs in the background and performs a number of small tasks. Some of these tasks are built in, others are started on demand.

The chances are you are looking here because you want to write a -KDED module. For that, see KDEDModule in kdecore and the -KDED +TrinityD module. For that, see TrinityDModule in kdecore and the +TrinityD README. @@ -22,5 +22,5 @@ Waldo Bastian \ */ // DOXYGEN_REFERENCES = kdecore kdeui kio -// DOXYGEN_SET_PROJECT_NAME = KDED +// DOXYGEN_SET_PROJECT_NAME = TrinityD // vim:ts=4:sw=4:expandtab:filetype=doxygen diff --git a/kdefx/Mainpage.dox b/kdefx/Mainpage.dox index 1cd8258fa..65fcadfc8 100644 --- a/kdefx/Mainpage.dox +++ b/kdefx/Mainpage.dox @@ -1,10 +1,10 @@ /** - * \mainpage The KDEfx Library + * \mainpage The Trinity special effects [fx] Library * * This library provides various classes related to image and pixmap * manipulation, a class that provides information about CPU support * for architecture specific features, as well as the base class for - * the %KDE widget styles. + * the %Trinity widget styles. * * The two graphical effects classes, KImageEffect and KPixmapEffect, * provide static methods for applying graphical effects to images and @@ -23,7 +23,7 @@ * architecture extensions that are useful when processing images, * such as MMX, SSE, 3DNow! and AltiVec. * - * KStyle is the base class for the %KDE widget styles. It simplifies + * KStyle is the base class for the %Trinity widget styles. It simplifies * and extends the QStyle API in order to make style coding easier. * It also provides an internal menu transparency and drop shadow * engine, which means that all styles inheriting this class will diff --git a/kdesu/Mainpage.dox b/kdesu/Mainpage.dox index 030ae3650..8105f9069 100644 --- a/kdesu/Mainpage.dox +++ b/kdesu/Mainpage.dox @@ -17,5 +17,5 @@ Adriaan de Groot \ */ // DOXYGEN_REFERENCES = kdecore -// DOXYGEN_SET_PROJECT_NAME = KDEsu +// DOXYGEN_SET_PROJECT_NAME = Trinitysu // vim:ts=4:sw=4:expandtab:filetype=doxygen diff --git a/kdeui/Mainpage.dox b/kdeui/Mainpage.dox index 1e360ee1c..bf6f6596d 100644 --- a/kdeui/Mainpage.dox +++ b/kdeui/Mainpage.dox @@ -6,10 +6,10 @@ */ /** -* @mainpage The KDE User Interface library +* @mainpage The Trinity User Interface library * * This library provides standard user interface elements for use in -* KDE applications. If your KDE application has a GUI, you will almost +* Trinity applications. If your Trinity application has a GUI, you will almost * certainly link to libkdeui. * * Most applications with single or multiple toplevel widgets diff --git a/kdoctools/Mainpage.dox b/kdoctools/Mainpage.dox index 9213252f6..5c102c941 100644 --- a/kdoctools/Mainpage.dox +++ b/kdoctools/Mainpage.dox @@ -1,7 +1,7 @@ -/** @mainpage KDE Documentation Tools +/** @mainpage Trinity Documentation Tools Provides a KIO slave for accessing application documentation for -KDE and GNOME applications. +Trinity and GNOME applications. @authors Eric Bischoff diff --git a/khtml/Mainpage.dox b/khtml/Mainpage.dox index 9dc968d02..20927a991 100644 --- a/khtml/Mainpage.dox +++ b/khtml/Mainpage.dox @@ -1,4 +1,4 @@ -/** @mainpage KDE HTML Parser and Widget +/** @mainpage Trinity HTML Parser and Widget If you want a fully-fledged HTML browser widget in your application, you can use KHTMLPart to do so. diff --git a/kinit/Mainpage.dox b/kinit/Mainpage.dox index e5c258575..5f76313c7 100644 --- a/kinit/Mainpage.dox +++ b/kinit/Mainpage.dox @@ -1,4 +1,4 @@ -/** @mainpage KDE Initialization Routines +/** @mainpage Trinity Initialization Routines kdeinit is a process launcher somewhat similar to the famous init used for booting UNIX. @@ -6,7 +6,7 @@ famous init used for booting UNIX. It launches processes by forking and then loading a dynamic library which should contain a 'main(...)' function. This both increases the startup speed and -reduces the memory consumption of KDE applications. +reduces the memory consumption of Trinity applications. kdeinit_wrapper, kshell and kwrapper provide methods of starting programs via kdeinit. diff --git a/kio/Mainpage.dox b/kio/Mainpage.dox index 80491a24d..bb7f2796f 100644 --- a/kio/Mainpage.dox +++ b/kio/Mainpage.dox @@ -2,17 +2,17 @@ * \mainpage A network-enabled file management system in a library * * This library implements almost all the file management functions you - * will ever need. In fact, the %KDE file manager, Konqueror also uses + * will ever need. In fact, the %Trinity file manager, Konqueror also uses * this to provide its network-enabled file management. * - * The easiest way to use this library from a %KDE application is via the + * The easiest way to use this library from a %Trinity application is via the * KIO::NetAccess class (for easy synchronous access) or via the * KIO::Job class (for more complex asynchronous jobs). * * This library also implements the System Configuration Cache (KSycoca). * * KMimeType: - * The notion of a file type, already existing in KDE-1.x + * The notion of a file type, already existing in Trinity-1.x * * KService: * To a mimetype are bound one or more applications, now called services. @@ -33,9 +33,9 @@ * Has its own language, in order to allow complex queries. * * - * \section KDE Filedialog widget and associated classes. + * \section Trinity Filedialog widget and associated classes. * - * This library also provides the KDE file selector widget, + * This library also provides the Trinity file selector widget, * its building blocks and some other widgets, making use of the file dialog. * * The file dialog provides different views; there is a vertically scrolling diff --git a/kjs/Mainpage.dox b/kjs/Mainpage.dox index e27a193c0..bad54558e 100644 --- a/kjs/Mainpage.dox +++ b/kjs/Mainpage.dox @@ -1,4 +1,4 @@ -/** @mainpage KDE JavaScript/EcmaScript Engine +/** @mainpage Trinity JavaScript/EcmaScript Engine This library provides an ECMAScript compatible interpreter. The ECMA standard is based on well known scripting languages such as Netscape's JavaScript and diff --git a/knewstuff/Mainpage.dox b/knewstuff/Mainpage.dox index ed863f4e2..f0fd034c1 100644 --- a/knewstuff/Mainpage.dox +++ b/knewstuff/Mainpage.dox @@ -1,6 +1,6 @@ -/** \mainpage Collaborative Data Sharing in KDE Applications +/** \mainpage Collaborative Data Sharing in Trinity Applications -The \b KNewStuff2 library adds data sharing capabilities to %KDE +The \b KNewStuff2 library adds data sharing capabilities to %Trinity applications. Technically, it implements the GHNS and DXS specifications. The library consists of three parts: the data management core diff --git a/kparts/Mainpage.dox b/kparts/Mainpage.dox index 257a96ce0..1a84ee131 100644 --- a/kparts/Mainpage.dox +++ b/kparts/Mainpage.dox @@ -1,6 +1,6 @@ -/** @mainpage Framework for KDE Graphical Components +/** @mainpage Framework for Trinity Graphical Components -This library implements the framework for KDE parts, which are +This library implements the framework for Trinity parts, which are elaborate widgets with a user-interface defined in terms of actions (menu items, toolbar icons). See KParts::Part. diff --git a/krandr/Mainpage.dox b/krandr/Mainpage.dox index 8264ba1dd..bb81d5756 100644 --- a/krandr/Mainpage.dox +++ b/krandr/Mainpage.dox @@ -1,6 +1,6 @@ /** \mainpage XRandr Interface for Trinity Applications -The \b KRandr library adds the ability for %KDE applications to easily configure an Xorg display via XRandr. +The \b KRandr library adds the ability for %Trinity applications to easily configure an Xorg display via XRandr. @authors Timothy Pearson \