KDE Games/API cleanup: Difference between revisions

Revision as of 17:47, 8 February 2012

libkdegames v5 is the new iteration of libkdegames which is intended to ship with KDE Development Platform 5 (though it may also happen earlier, e.g. 4.9). The aim for this new iteration of the library is to remove most of the API that is obsolete, unused or in a state of bad quality, in order to improve maintainability and relevance of the remaining API. Also, QtWidgets-specific parts need to be separated to prepare for QML-based games.

The fine print: The SO version for libkdegames v5 is actually 6.

List of components

libkdegames consists of multiple (possibly interdependent) components, as defined by this list. The "Dependencies" column records only dependencies to other libkdegames components. See the table below for which file belongs to which component.

Component	Short desc.	Dependencies	Current maintainer
highscore	Highscore recording and GUI.	-
kgamecanvas	Alternative to QGraphicsView.	kgamerenderer (integration)
kgamerenderer	Rendering of theme graphics.	theming	Stefan Majewsky
kggz	Network-enabled multiplayer.	-

List of files

Source file	Belongs to component
cardcache.cpp/h/ph
carddeckinfo.cpp/h/ph
chooserastergraphicssystem.cpp
colorproxy_p.cpp/h	kgamerenderer
digits/kgamesvgdigits.cpp/h
highscore/kexthighscore.cpp/h	highscore
highscore/kexthighscore_gui.cpp/h	highscore
highscore/kexthighscore_internal.cpp/h	highscore
highscore/kexthighscore_item.cpp/h	highscore
highscore/kexthighscore_tab.cpp/h	highscore
highscore/khighscore.cpp/h	highscore
highscore/kscoredialog.cpp/h	highscore
kcarddialog.cpp/h
kchatbase.cpp/h
kchatbaseitemdelegate.cpp/h
kchatbasemodel.cpp/h
kchat.cpp/h
kchatdialog.cpp/h
kgamecanvas.cpp/h	kgamecanvas
kgameclock.cpp/h
kgame/dialogs/kgameconnectdialog.cpp/h
kgame/dialogs/kgamedebugdialog.cpp/h
kgame/dialogs/kgamedialogconfig.cpp/h
kgame/dialogs/kgamedialog.cpp/h
kgame/dialogs/kgameerrordialog.cpp/h
kgamedifficulty.cpp/h
kgame/kgamechat.cpp/h
kgame/kgame.cpp/h
kgame/kgameerror.cpp/h
kgame/kgameio.cpp/h
kgame/kgamemessage.cpp/h
kgame/kgamenetwork.cpp/h
kgame/kgameprocess.cpp/h
kgame/kgamepropertyarray.h
kgame/kgameproperty.cpp/h
kgame/kgamepropertyhandler.cpp/h
kgame/kgamesequence.cpp/h
kgame/kgameversion.h
kgame/kmessageclient.cpp/h
kgame/kmessageio.cpp/h
kgame/kmessageserver.cpp/h/ph
kgame/kplayer.cpp/h
kgamelcd.cpp/h
kgamemisc.cpp/h
kgamepopupitem.cpp/h
kgameprogress.cpp/h
kgamerendereditem.cpp/h	kgamerenderer
kgamerenderedobjectitem.cpp/h	kgamerenderer
kgamerendererclient.cpp/h	kgamerenderer
kgamerenderer.cpp/h/ph	kgamerenderer
kgamesvgdocument.cpp/h/ph
kgametheme.cpp/h
kgamethemeselector.cpp/h
kggzgames/kggzgames_export.h	kggz
kggzgames/kggzrankingsdialog.cpp/h	kggz
kggzgames/kggzseatsdialog.cpp/h	kggz
kggzmod/event.cpp/h	kggz
kggzmod/kggzmod_export.h	kggz
kggzmod/misc_private.h	kggz
kggzmod/module.cpp/h/ph	kggz
kggzmod/player.cpp/h/ph	kggz
kggzmod/request.cpp/h	kggz
kggzmod/statistics.cpp/h/ph	kggz
kggznet/kggznet_export.h	kggz
kggznet/kggzpacket.cpp/h	kggz
kggznet/kggzraw.cpp/h	kggz
kgrid2d.h
kstandardgameaction.cpp/h
libkdegames_export.h
tests/kgamepopupitemtest.cpp/h
tests/kgamepropertytest.cpp/h
tests/kgamesvgdigitstest.cpp/h
tests/kgamesvgdocumenttest.cpp/h
includes/KCardCache
includes/KCardDeckInfo
includes/KCardDialog
includes/KChat
includes/KChatBase
includes/KChatBaseItemDelegate
includes/KChatDialog
includes/KExtHighscore	highscore
includes/KGameCanvas	kgamecanvas
includes/KGameClock
includes/KGameDifficulty
includes/KGame/KGame
includes/KGame/KGameChat
includes/KGame/KGameConnectDialog
includes/KGame/KGameDebugDialog
includes/KGame/KGameDialog
includes/KGame/KGameDialogConfig
includes/KGame/KGameError
includes/KGame/KGameErrorDialog
includes/KGame/KGameIO
includes/KGame/KGameMessage
includes/KGame/KGameNetwork
includes/KGame/KGameProcess
includes/KGame/KGameProperty
includes/KGame/KGamePropertyArray
includes/KGame/KGamePropertyHandler
includes/KGame/KGameSequence
includes/KGame/KGameVersion
includes/KGame/KMessageClient
includes/KGame/KMessageIO
includes/KGame/KMessageServer
includes/KGame/KPlayer
includes/KGameLCD
includes/KGameMisc
includes/KGamePopupItem
includes/KGameProgress
includes/KGameRenderedItem	kgamerenderer
includes/KGameRenderedObjectItem	kgamerenderer
includes/KGameRenderer	kgamerenderer
includes/KGameRendererClient	kgamerenderer
includes/KGameSvgDigits
includes/KGameSvgDocument
includes/KGameTheme
includes/KGameThemeSelector
includes/KGGZRankingsDialog	kggz
includes/KGGZSeatsDialog	kggz
includes/KGrid2D
includes/KHighscore	highscore
includes/KScoreDialog	highscore
includes/KStandardGameAction

@@ Line 5: / Line 5: @@
 == List of components ==
-libkdegames consists of multiple (possibly interdependent) components, as defined by this list. See the list below for which file belongs to which component.
+libkdegames consists of multiple (possibly interdependent) components, as defined by this list. The "Dependencies" column records only dependencies to other libkdegames components. See the table below for which file belongs to which component.
 {| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width:100%;"
 |- style="background: #ececec; white-space:nowrap;"
 ! Component
-! Description
+! Short desc.
-! Dependencies (on other components)
+! Dependencies
-!  width=120 | Current maintainer
+! Current maintainer
 |-
 | highscore
-| Records and displays highscores.
+| Highscore recording and GUI.
 | -
 |
@@ Line 25: / Line 25: @@
 |-
 | kgamerenderer
-| Multithreaded rendering of (static) theme graphics.
+| Rendering of theme graphics.
 | theming
 | Stefan Majewsky