andpp/mopidy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: Include API docs for the Core class

Browse Source
This commit is contained in:
Stein Magnus Jodal 2013-12-15 21:39:53 +01:00
parent 7b667028e1
commit b0b2e37950
2 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/core.rst
View File

@ -7,11 +7,13 @@ Core API
.. module:: mopidy.core
:synopsis: Core API for use by frontends
The core API is the interface that is used by frontends like
:mod:`mopidy.frontends.mpd`. The core layer is inbetween the frontends and the
backends.
.. autoclass:: mopidy.core.Core
:members:
Playback controller
===================

16
mopidy/core/actor.py
View File

@ -16,21 +16,21 @@ from .tracklist import TracklistController
class Core(pykka.ThreadingActor, AudioListener, BackendListener):
#: The library controller. An instance of
# :class:`mopidy.core.LibraryController`.
library = None
"""The library controller. An instance of
:class:`mopidy.core.LibraryController`."""
#: The playback controller. An instance of
#: :class:`mopidy.core.PlaybackController`.
playback = None
"""The playback controller. An instance of
:class:`mopidy.core.PlaybackController`."""
#: The playlists controller. An instance of
#: :class:`mopidy.core.PlaylistsController`.
playlists = None
"""The playlists controller. An instance of
:class:`mopidy.core.PlaylistsController`."""
#: The tracklist controller. An instance of
#: :class:`mopidy.core.TracklistController`.
tracklist = None
"""The tracklist controller. An instance of
:class:`mopidy.core.TracklistController`."""
def __init__(self, audio=None, backends=None):
super(Core, self).__init__()