Browse Source

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
tags/v3.5.13
tpearson 10 years ago
parent
commit
a93c19aaac
17 changed files with 86 additions and 88 deletions
  1. +42
    -42
      Mainpage.dox
  2. +5
    -5
      dcop/Mainpage.dox
  3. +1
    -1
      dnssd/Mainpage.dox
  4. +1
    -1
      kconf_update/Mainpage.dox
  5. +10
    -12
      kdecore/Mainpage.dox
  6. +5
    -5
      kded/Mainpage.dox
  7. +3
    -3
      kdefx/Mainpage.dox
  8. +1
    -1
      kdesu/Mainpage.dox
  9. +2
    -2
      kdeui/Mainpage.dox
  10. +2
    -2
      kdoctools/Mainpage.dox
  11. +1
    -1
      khtml/Mainpage.dox
  12. +2
    -2
      kinit/Mainpage.dox
  13. +5
    -5
      kio/Mainpage.dox
  14. +1
    -1
      kjs/Mainpage.dox
  15. +2
    -2
      knewstuff/Mainpage.dox
  16. +2
    -2
      kparts/Mainpage.dox
  17. +1
    -1
      krandr/Mainpage.dox

+ 42
- 42
Mainpage.dox View File

@@ -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
* <a href="http://trinity.pearsoncomputing.net/">trinity.pearsoncomputing.net</a>. Additionally, you
* <a target="_top" href="http://trinity.pearsoncomputing.net/">trinity.pearsoncomputing.net</a>. Additionally, you
* can subscribe or read the mailing lists for any additions and/or
* modifications to the API.
*
* - <a href="kdecore/html/index.html"><b>kdecore</b></a>
* (<a href="kdecore/html/classes.html">classes</a>)\n
* - <a target="_top" href="kdecore/html/index.html"><b>kdecore</b></a>
* (<a target="_top" href="kdecore/html/classes.html">classes</a>)\n
* <i>Core Trinity classes that are not related to the user interface.</i>
* - <a href="kdeui/html/index.html"><b>kdeui</b></a>
* (<a href="kdeui/html/classes.html">classes</a>)\n
* - <a target="_top" href="kdeui/html/index.html"><b>kdeui</b></a>
* (<a target="_top" href="kdeui/html/classes.html">classes</a>)\n
* <i>Trinity User interface classes such as widgets.</i>
* - <a href="khtml/html/index.html"><b>khtml</b></a>
* (<a href="khtml/html/classes.html">classes</a>)\n
* - <a target="_top" href="khtml/html/index.html"><b>khtml</b></a>
* (<a target="_top" href="khtml/html/classes.html">classes</a>)\n
* <i>The Trinity HTML component.</i>
* - <a href="kjs/html/index.html"><b>kjs</b></a>
* (<a href="kjs/html/classes.html">classes</a>)\n
* - <a target="_top" href="kjs/html/index.html"><b>kjs</b></a>
* (<a target="_top" href="kjs/html/classes.html">classes</a>)\n
* <i>Javascript (aka. ECMAScript and JScript) support.</i>
* - <a href="kio/html/index.html"><b>kio</b></a>
* (<a href="kio/kio/html/classes.html">classes</a>)\n
* - <a target="_top" href="kio/html/index.html"><b>kio</b></a>
* (<a target="_top" href="kio/kio/html/classes.html">classes</a>)\n
* <i>Low level access to network files. Also provides access to facilities
* such as KDirWatcher which monitors directories for changes.</i>
* - <a href="kparts/html/index.html"><b>kparts</b></a>
* (<a href="kparts/html/classes.html">classes</a>)\n
* - <a target="_top" href="kparts/html/index.html"><b>kparts</b></a>
* (<a target="_top" href="kparts/html/classes.html">classes</a>)\n
* <i>Support for re-usable, embeddable, extendable applications.</i>
* - <a href="dcop/html/index.html"><b>dcop</b></a>
* (<a href="dcop/html/classes.html">classes</a>)\n
* - <a target="_top" href="dcop/html/index.html"><b>dcop</b></a>
* (<a target="_top" href="dcop/html/classes.html">classes</a>)\n
* <i>The DCOP communications library.</i>
* - <a href="kdefx/html/index.html"><b>kdefx</b></a>
* (<a href="kdefx/html/classes.html">classes</a>)\n
* - <a target="_top" href="kdefx/html/index.html"><b>kdefx</b></a>
* (<a target="_top" href="kdefx/html/classes.html">classes</a>)\n
* <i>A library with pixmap effects.</i>
* - <a href="kmdi/html/index.html"><b>kmdi</b></a>
* (<a href="kmdi/html/classes.html">classes</a>)\n
* - <a target="_top" href="kmdi/html/index.html"><b>kmdi</b></a>
* (<a target="_top" href="kmdi/html/classes.html">classes</a>)\n
* <i>MultiDocument Interface library.</i>
* - <a href="libkmid/html/index.html"><b>libkmid</b></a>
* (<a href="libkmid/html/classes.html">classes</a>)\n
* - <a target="_top" href="libkmid/html/index.html"><b>libkmid</b></a>
* (<a target="_top" href="libkmid/html/classes.html">classes</a>)\n
* <i>Midi library.</i>
* - <a href="kdeprint/html/index.html"><b>kdeprint</b></a>
* (<a href="kdeprint/html/classes.html">classes</a>)\n
* - <a target="_top" href="kdeprint/html/index.html"><b>kdeprint</b></a>
* (<a target="_top" href="kdeprint/html/classes.html">classes</a>)\n
* <i>High level printer control functionality.</i>
* - <a href="krandr/html/index.html"><b>krandr</b></a>
* (<a href="krandr/html/classes.html">classes</a>)\n
* - <a target="_top" href="krandr/html/index.html"><b>krandr</b></a>
* (<a target="_top" href="krandr/html/classes.html">classes</a>)\n
* <i>High level Xorg configuration via XRandr.</i>
* - <a href="interfaces/html/index.html"><b>interfaces</b></a>
* (<a href="interfaces/html/classes.html">classes</a>)\n
* - <a target="_top" href="interfaces/html/index.html"><b>interfaces</b></a>
* (<a target="_top" href="interfaces/html/classes.html">classes</a>)\n
* <i>Defines interfaces for common components so that new implementations
* can be dropped in.</i>
* - <a href="kabc/html/index.html"><b>kabc</b></a>
* (<a href="kabc/html/classes.html">classes</a>)\n
* - <a target="_top" href="kabc/html/index.html"><b>kabc</b></a>
* (<a target="_top" href="kabc/html/classes.html">classes</a>)\n
* <i>Access to the Trinity address book.</i>
* - <a href="kresources/html/index.html"><b>kresources</b></a>
* (<a href="kresources/html/classes.html">classes</a>)\n
* - <a target="_top" href="kresources/html/index.html"><b>kresources</b></a>
* (<a target="_top" href="kresources/html/classes.html">classes</a>)\n
* <i>The Trinity resources system.</i>
* - <a href="kutils/html/index.html"><b>kutils</b></a>
* (<a href="kutils/html/classes.html">classes</a>)\n
* - <a target="_top" href="kutils/html/index.html"><b>kutils</b></a>
* (<a target="_top" href="kutils/html/classes.html">classes</a>)\n
* <i>High-level utils, like search/replace support.</i>
* - <a href="arts/html/index.html"><b>arts</b></a>
* (<a href="arts/html/classes.html">classes</a>)\n
* - <a target="_top" href="arts/html/index.html"><b>arts</b></a>
* (<a target="_top" href="arts/html/classes.html">classes</a>)\n
* <i>Trinity bindings for arts including knotify.</i>
* - <a href="knewstuff/html/index.html"><b>knewstuff</b></a>
* (<a href="knewstuff/html/classes.html">classes</a>)\n
* - <a target="_top" href="knewstuff/html/index.html"><b>knewstuff</b></a>
* (<a target="_top" href="knewstuff/html/classes.html">classes</a>)\n
* <i>Upload and download of application data.</i>
* - <a href="dnssd/html/index.html"><b>dnssd</b></a>
* (<a href="dnssd/html/classes.html">classes</a>)\n
* - <a target="_top" href="dnssd/html/index.html"><b>dnssd</b></a>
* (<a target="_top" href="dnssd/html/classes.html">classes</a>)\n
* <i>Network sevices publishing and discovery.</i>
* - <a href="kunittest/html/index.html"><b>kunittest</b></a>
* (<a href="kunittest/html/classes.html">classes</a>)\n
* - <a target="_top" href="kunittest/html/index.html"><b>kunittest</b></a>
* (<a target="_top" href="kunittest/html/classes.html">classes</a>)\n
* <i>Unit testing framework in Trinity.</i>

*
* More information about the Trinity architecture in form of tutorials, HOWTOs,
* and FAQs can be found at
* the <a href="http://trinity.pearsoncomputing.net">the Trinity project</a>.
* the <a target="_top" href="http://trinity.pearsoncomputing.net">the Trinity project</a>.
*/

/**


+ 5
- 5
dcop/Mainpage.dox View File

@@ -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 \<kde-core-devel@kde.org\>.
inter-process communication with Trinity! Please direct all comments and/or
suggestions to the Trinity Core Developers List \<kde-core-devel@kde.org\>.

*/

+ 1
- 1
dnssd/Mainpage.dox View File

@@ -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*


+ 1
- 1
kconf_update/Mainpage.dox View File

@@ -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 <a href="http://websvn.kde.org/trunk/KDE/kdelibs/kconf_update/README.kconf_update?view=markup">README file</a> for more information.
See the README file for more information.

@authors
Waldo Bastian \<bastian@kde.org\>


+ 10
- 12
kdecore/Mainpage.dox View File

@@ -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.
<p>
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
<a href="http://techbase.kde.org/Development/Tutorials">tutorials on
TechBase</a> to get you going.
<a href="http://trinity.pearsoncomputing.net">tutorials on
the Trinity project site</a> to get you going.

If you know what you are looking for, you should be able to find it in
the <a href="annotated.html">class list</a> or the
@@ -22,9 +22,7 @@ the <a href="annotated.html">class list</a> or the
Various: see copyrights on individual files for more information

@maintainers
See the
<a href="http://websvn.kde.org/trunk/KDE/kdelibs/kdecore/MAINTAINERS?view=markup">MAINTAINERS</a>
file.
See the MAINTAINERS file.

@licenses
Library: @lgpl<br>
@@ -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

+ 5
- 5
kded/Mainpage.dox View File

@@ -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.
<p>
The chances are you are looking here because you want to write a
KDED module. For that, see KDEDModule in kdecore and the
<a href="http://websvn.kde.org/trunk/KDE/kdelibs/kded/README.kded?view=markup">KDED
TrinityD module. For that, see TrinityDModule in kdecore and the
<a href="http://websvn.kde.org/trunk/Trinity/kdelibs/kded/README.kded?view=markup">TrinityD
README</a>.


@@ -22,5 +22,5 @@ Waldo Bastian \<bastian@kde.org\>
*/

// DOXYGEN_REFERENCES = kdecore kdeui kio
// DOXYGEN_SET_PROJECT_NAME = KDED
// DOXYGEN_SET_PROJECT_NAME = TrinityD
// vim:ts=4:sw=4:expandtab:filetype=doxygen

+ 3
- 3
kdefx/Mainpage.dox View File

@@ -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


+ 1
- 1
kdesu/Mainpage.dox View File

@@ -17,5 +17,5 @@ Adriaan de Groot \<groot@kde.org\>
*/

// DOXYGEN_REFERENCES = kdecore
// DOXYGEN_SET_PROJECT_NAME = KDEsu
// DOXYGEN_SET_PROJECT_NAME = Trinitysu
// vim:ts=4:sw=4:expandtab:filetype=doxygen

+ 2
- 2
kdeui/Mainpage.dox View File

@@ -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


+ 2
- 2
kdoctools/Mainpage.dox View File

@@ -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


+ 1
- 1
khtml/Mainpage.dox View File

@@ -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.


+ 2
- 2
kinit/Mainpage.dox View File

@@ -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.


+ 5
- 5
kio/Mainpage.dox View File

@@ -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


+ 1
- 1
kjs/Mainpage.dox View File

@@ -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


+ 2
- 2
knewstuff/Mainpage.dox View File

@@ -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
<a href="http://ghns.freedesktop.org/">GHNS</a> and
DXS specifications. The library consists of three parts: the data management core


+ 2
- 2
kparts/Mainpage.dox View File

@@ -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.



+ 1
- 1
krandr/Mainpage.dox View File

@@ -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 \<kb9vqf@pearsoncomputing.net\>


Loading…
Cancel
Save