From b4c73c63079bd8fe81a5990ae59055e1fa8dc54e Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Mon, 26 Dec 2011 13:54:48 +0000 Subject: [PATCH] Fix documentation --- api/source/conf.py | 4 ++-- api/source/core/lib.rst | 16 ++++++++++++++-- api/source/core/ui.rst | 3 +++ api/source/plugins/media.rst | 10 +++++----- 4 files changed, 24 insertions(+), 9 deletions(-) diff --git a/api/source/conf.py b/api/source/conf.py index 51ecfee..8c78b0f 100644 --- a/api/source/conf.py +++ b/api/source/conf.py @@ -39,7 +39,7 @@ master_doc = 'index' # General information about the project. project = u'OpenLP' -copyright = u'2004-2010, Raoul Snyman' +copyright = u'2004-2011, Raoul Snyman' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -48,7 +48,7 @@ copyright = u'2004-2010, Raoul Snyman' # The short X.Y version. version = '2.0' # The full version, including alpha/beta/rc tags. -release = '1.9.3' +release = '1.9.8' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/api/source/core/lib.rst b/api/source/core/lib.rst index 6be95de..b8c0570 100644 --- a/api/source/core/lib.rst +++ b/api/source/core/lib.rst @@ -6,6 +6,12 @@ Object Library .. automodule:: openlp.core.lib :members: +:mod:`Manager` +-------------------- + +.. autoclass:: openlp.core.lib.db.Manager + :members: + :mod:`EventReceiver` -------------------- @@ -42,10 +48,10 @@ Object Library .. autoclass:: openlp.core.lib.renderer.Renderer :members: -:mod:`RenderManager` +:mod:`SearchEdit` -------------------- -.. autoclass:: openlp.core.lib.rendermanager.RenderManager +.. autoclass:: openlp.core.lib.searchedit.SearchEdit :members: :mod:`ServiceItem` @@ -65,3 +71,9 @@ Object Library .. autoclass:: openlp.core.lib.toolbar.OpenLPToolbar :members: + +:mod:`UiStrings` +-------------------- + +.. autoclass:: openlp.core.lib.ui.UiStrings + :members: \ No newline at end of file diff --git a/api/source/core/ui.rst b/api/source/core/ui.rst index 63db747..004b10e 100644 --- a/api/source/core/ui.rst +++ b/api/source/core/ui.rst @@ -17,6 +17,9 @@ Main Windows Managers -------- +.. autoclass:: openlp.core.ui.slidecontroller.SlideController + :members: + .. autoclass:: openlp.core.ui.servicemanager.ServiceManager :members: diff --git a/api/source/plugins/media.rst b/api/source/plugins/media.rst index a8486c9..e5a49db 100644 --- a/api/source/plugins/media.rst +++ b/api/source/plugins/media.rst @@ -6,17 +6,17 @@ Media Plugin .. automodule:: openlp.plugins.media :members: -Plugin Class ------------- + Plugin Class + ------------ .. autoclass:: openlp.plugins.media.mediaplugin.MediaPlugin :members: -Helper Classes & Functions --------------------------- + Helper Classes & Functions + -------------------------- .. automodule:: openlp.plugins.media.lib :members: -.. automodule:: openlp.plugins.media.lib.mediaitem + .. automodule:: openlp.plugins.media.lib.mediaitem :members: