alecs/plasma-framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Some documentation improvements and corrections, including renaming the documentation section from libplasma to Plasma, for consistency with other parts of kdelibs.

Browse Source 
svn path=/trunk/KDE/kdelibs/; revision=888086
This commit is contained in:
Alex Merry 2008-11-23 18:39:58 +00:00
parent 902fb25a82
commit ae5622817c
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Mainpage.dox
View File

@ -13,18 +13,16 @@ framework</a> and the <a href="http://api.kde.org/4.x-api/kdelibs-apidocs/">KDE
libraries</a> provide the underpinning for libplasma. As a result, it should libraries</a> provide the underpinning for libplasma. As a result, it should
work anywhere that Qt and KDE do. work anywhere that Qt and KDE do.
Although libplasma is developed for the use of Plasma, the new desktop shell in Although libplasma is developed for the use of the Plasma desktop shell in
KDE 4, it is general enough to be useful in other applications. KDE 4, it is general enough to be useful in other applications.
<a href="http://amarok.kde.org">Amarok</a> is already using it for its context <a href="http://amarok.kde.org">Amarok</a> is using it for its context
view, allowing for pluggable widgets to display and interact with the music view, allowing for pluggable widgets to display and interact with the music
collection, such as "current track" and "tag cloud" widgets. collection, such as "current track" and "tag cloud" widgets.
libplasma itself only provides a framework, and the widgets, containments, libplasma itself only provides a framework, and the widgets, containments,
data engines and runners are all implemented as plugins. However, the framework data engines and runners are all implemented as plugins. However, the framework
is designed to make implementing these plugins as easy as possible, including is designed to make implementing these plugins as easy as possible, including
providing scripting support. Also, infrastructure such as a dialog to install providing scripting support.
new widgets and even download them from the web (Plasma::AppletBrowser) is also
included.
Other important classes are: Other important classes are:
@ -40,7 +38,7 @@ Other important classes are:
mouse is hovered over them mouse is hovered over them
- Plasma::Dialog: displays a themed application dialog - Plasma::Dialog: displays a themed application dialog
- Plasma::Extender: provides detachable sections to Plasma::Applet - Plasma::Extender: provides detachable sections to Plasma::Applet
- Plasma::GLApplet: provides an OpneGL-rendered Plasma::Applet - Plasma::GLApplet: provides an OpenGL-rendered Plasma::Applet
- Plasma::PackageStructure: provides descriptions of packages containing plugins - Plasma::PackageStructure: provides descriptions of packages containing plugins
for libplasma for libplasma
- Plasma::PopupApplet: provides a simple way of implementing a Plasma::Applet - Plasma::PopupApplet: provides a simple way of implementing a Plasma::Applet
@ -95,6 +93,6 @@ Aaron Seigo \<aseigo@kde.org\>
*/ */
// DOXYGEN_SET_PROJECT_NAME = libplasma // DOXYGEN_SET_PROJECT_NAME = Plasma
// DOXYGEN_SET_RECURSIVE = YES // DOXYGEN_SET_RECURSIVE = YES
// vim:ts=4:sw=4:expandtab:filetype=doxygen // vim:ts=4:sw=4:expandtab:filetype=doxygen