Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
[doxygen] Add revision when Python API was changed, expanded or depre…
…cated
  • Loading branch information
MartijnKaijser committed Oct 7, 2016
1 parent 87fabf2 commit c97066c
Show file tree
Hide file tree
Showing 15 changed files with 157 additions and 28 deletions.
8 changes: 7 additions & 1 deletion .codedocs
Expand Up @@ -12,7 +12,13 @@ ALIASES = "table_start=<table width= 100% style= border bgcolor=
"python_func_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style="float:right;"><small>\2</small></span></h4> \endhtmlonly" \
"python_class{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
"python_class_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style="float:right;"><small>\2</small></span></h4> \endhtmlonly" \
"doc_header{1}=\htmlonly <h3><span style=\"text-decoration: underline;\"><span style=\"font-style: italic;\"><span style=\"color: rgb(102, 102, 102);\">\1</span></span></span></h3> \endhtmlonly"
"doc_header{1}=\htmlonly <h3><span style=\"text-decoration: underline;\"><span style=\"font-style: italic;\"><span style=\"color: rgb(102, 102, 102);\">\1</span></span></span></h3> \endhtmlonly" \
"python_v12=\xrefitem python_v12 \"v12 Python API changes\" \"\"" \
"python_v13=\xrefitem python_v13 \"v13 Python API changes\" \"\"" \
"python_v14=\xrefitem python_v14 \"v14 Python API changes\" \"\"" \
"python_v15=\xrefitem python_v15 \"v15 Python API changes\" \"\"" \
"python_v16=\xrefitem python_v16 \"v16 Python API changes\" \"\"" \
"python_v17=\xrefitem python_v17 \"v17 Python API changes\" \"\""

# Hide undocumented class members.
HIDE_UNDOC_MEMBERS =
Expand Down
8 changes: 7 additions & 1 deletion doxygen_resources/Doxyfile.doxy
Expand Up @@ -248,7 +248,13 @@ ALIASES = "table_start=<table width= 100% style= border bgcolor=
"python_func_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style="float:right;"><small>\2</small></span></h4> \endhtmlonly" \
"python_class{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
"python_class_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style="float:right;"><small>\2</small></span></h4> \endhtmlonly" \
"doc_header{1}=\htmlonly <h3><span style=\"text-decoration: underline;\"><span style=\"font-style: italic;\"><span style=\"color: rgb(102, 102, 102);\">\1</span></span></span></h3> \endhtmlonly"
"doc_header{1}=\htmlonly <h3><span style=\"text-decoration: underline;\"><span style=\"font-style: italic;\"><span style=\"color: rgb(102, 102, 102);\">\1</span></span></span></h3> \endhtmlonly" \
"python_v12=\xrefitem python_v12 \"v12 Python API changes\" \"\"" \
"python_v13=\xrefitem python_v13 \"v13 Python API changes\" \"\"" \
"python_v14=\xrefitem python_v14 \"v14 Python API changes\" \"\"" \
"python_v15=\xrefitem python_v15 \"v15 Python API changes\" \"\"" \
"python_v16=\xrefitem python_v16 \"v16 Python API changes\" \"\"" \
"python_v17=\xrefitem python_v17 \"v17 Python API changes\" \"\""

# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
Expand Down
8 changes: 7 additions & 1 deletion xbmc/addons/kodi-addon-dev-kit/doxygen/Doxyfile
Expand Up @@ -248,7 +248,13 @@ ALIASES = "table_start=<table width= 100% style= border bgcolor=
"python_func_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style="float:right;"><small>\2</small></span></h4> \endhtmlonly" \
"python_class{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
"python_class_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style="float:right;"><small>\2</small></span></h4> \endhtmlonly" \
"doc_header{1}=\htmlonly <h3><span style=\"text-decoration: underline;\"><span style=\"font-style: italic;\"><span style=\"color: rgb(102, 102, 102);\">\1</span></span></span></h3> \endhtmlonly"
"doc_header{1}=\htmlonly <h3><span style=\"text-decoration: underline;\"><span style=\"font-style: italic;\"><span style=\"color: rgb(102, 102, 102);\">\1</span></span></span></h3> \endhtmlonly" \
"python_v12=\xrefitem python_v12 \"v12 Python API changes\" \"\"" \
"python_v13=\xrefitem python_v13 \"v13 Python API changes\" \"\"" \
"python_v14=\xrefitem python_v14 \"v14 Python API changes\" \"\"" \
"python_v15=\xrefitem python_v15 \"v15 Python API changes\" \"\"" \
"python_v16=\xrefitem python_v16 \"v16 Python API changes\" \"\"" \
"python_v17=\xrefitem python_v17 \"v17 Python API changes\" \"\""

# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
Expand Down
11 changes: 11 additions & 0 deletions xbmc/addons/kodi-addon-dev-kit/doxygen/General/General.dox
Expand Up @@ -16,3 +16,14 @@ Guideline for Kodi's developers to create documentation
\subpage Doxygen_On_Addon

*/

---------------------------------------------------------------------------------

@subpage revisions "Revisions against older versions"
*/

/*!
\page revisions Revisions

\subpage python_revisions
*/
Expand Up @@ -37,7 +37,7 @@ uses a handful of custom modules to expose Kodi functionality to Python.
|------------------------------------:|:-----------------------------------------------------------|
| \ref python_xbmc "xbmc" | Offers classes and functions that provide information about the media currently playing and that allow manipulation of the media player (such as starting a new song). You can also find system information using the functions available in this library.
| \ref python_xbmcgui "xbmcgui" | Offers classes and functions that manipulate the Graphical User Interface through windows, dialogs, and various control widgets.
| \ref python_xbmcplugin "xbmcplugin" | Offers classes and functions that allow a developer to present information through Kodi's standard menu structure. While plugins don't have the same flexibility as scripts, they boast significantly quicker development time and a more consistent user experience.
| \ref python_xbmcplugin "xbmcplugin" | Offers classes and functions that allow a developer to present information through Kodi's standard menu structure. While plugins don't have the same flexibility as scripts, they boast significantly quicker development time and a more consistent user experience.
| \ref python_xbmcaddon "xbmcaddon" | Offers classes and functions that manipulate the add-on settings, information and localization.
| \ref python_xbmcvfs "xbmcvfs" | Offers classes and functions offers access to the Virtual File Server (VFS) which you can use to manipulate files and folders.
| \ref python_xbmcwsgi "xbmcwsgi" | The [<b>Web Server Gateway Interface (WSGI)</b>](https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface) is a specification for simple and universal interface between web servers and web applications or frameworks for the Python programming language.
Expand Down Expand Up @@ -141,3 +141,35 @@ web applications or frameworks for the Python programming language.
@}

*/

/*!
@page python_v12 Python API v12
*/
/*!
@page python_v13 Python API v13
*/
/*!
@page python_v14 Python API v14
*/
/*!
@page python_v15 Python API v15
*/
/*!
@page python_v16 Python API v16
*/
/*!
@page python_v17 Python API v17
*/

/*!
@page python_revisions Python API Changes
@brief Overview of changes on Python API for Kodi

- @subpage python_v12
- @subpage python_v13
- @subpage python_v14
- @subpage python_v15
- @subpage python_v16
- @subpage python_v17
+*/

2 changes: 2 additions & 0 deletions xbmc/interfaces/legacy/Control.h
Expand Up @@ -2538,6 +2538,7 @@ namespace XBMCAddon
///
///
///--------------------------------------------------------------------------
/// @python_v16 Deprecated **focusTexture** and **noFocusTexture**. Use **focusOnTexture** and **noFocusOnTexture**.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
Expand Down Expand Up @@ -2763,6 +2764,7 @@ namespace XBMCAddon
///
///
///--------------------------------------------------------------------------
/// @python_v17 **orientation** option added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
Expand Down
4 changes: 4 additions & 0 deletions xbmc/interfaces/legacy/Dialog.h
Expand Up @@ -120,6 +120,7 @@ namespace XBMCAddon
///
///
///------------------------------------------------------------------------
/// @python_v17 **preselect** option added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
Expand Down Expand Up @@ -148,6 +149,7 @@ namespace XBMCAddon
///
///
///--------------------------------------------------------------------------
/// @python_v17 New function added
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
Expand Down Expand Up @@ -181,6 +183,8 @@ namespace XBMCAddon
///
///
///------------------------------------------------------------------------
/// @python_v16 New function added.
/// @python_v17 Added new option **preselect**.
///
/// **Example:**
/// @code{.py}
Expand Down
10 changes: 5 additions & 5 deletions xbmc/interfaces/legacy/InfoTagVideo.h
Expand Up @@ -76,7 +76,7 @@ namespace XBMCAddon
///
///
///-----------------------------------------------------------------------
///
/// @python_v17 New function added.
///
getDbId();
#else
Expand Down Expand Up @@ -240,7 +240,7 @@ namespace XBMCAddon
///
///
///-----------------------------------------------------------------------
///
/// @python_v17 New function added.
///
getTVShowTitle();
#else
Expand Down Expand Up @@ -268,7 +268,7 @@ namespace XBMCAddon
/// | episode | The type is used as a series episode
///
///-----------------------------------------------------------------------
///
/// @python_v17 New function added.
///
getMediaType();
#else
Expand Down Expand Up @@ -377,7 +377,7 @@ namespace XBMCAddon
///
///
///-----------------------------------------------------------------------
///
/// @python_v17 New function added.
///
getSeason();
#else
Expand All @@ -395,7 +395,7 @@ namespace XBMCAddon
///
///
///-----------------------------------------------------------------------
///
/// @python_v17 New function added.
///
getEpisode();
#else
Expand Down
22 changes: 15 additions & 7 deletions xbmc/interfaces/legacy/ListItem.h
Expand Up @@ -199,7 +199,7 @@ namespace XBMCAddon
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setIconImage(iconImage) }
///-----------------------------------------------------------------------
/// @warning Deprecated. Use setArt
/// @python_v16 Deprecated. Use **setArt()**.
///
setIconImage(...);
#else
Expand All @@ -211,7 +211,7 @@ namespace XBMCAddon
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ setThumbnailImage(thumbFilename) }
///-----------------------------------------------------------------------
/// @warning Deprecated. Use setArt
/// @python_v16 Deprecated. Use **setArt()**.
///
setThumbnailImage(...);
#else
Expand Down Expand Up @@ -345,8 +345,8 @@ namespace XBMCAddon
/// | icon | string - image path
///
///
///
///-----------------------------------------------------------------------
/// @python_v17 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
Expand Down Expand Up @@ -613,6 +613,9 @@ namespace XBMCAddon
///
///
///-----------------------------------------------------------------------
/// @python_v17
/// Added labels **setid**, **set**, **imdbnumber**, **code** and **dbid**.
/// Expanded the possible infoLabels for the option **mediatype**.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
Expand Down Expand Up @@ -683,7 +686,6 @@ namespace XBMCAddon
/// @param items list - [(label, action,)*] A list of tuples consisting of label and action pairs.
/// - label string or unicode - item's label.
/// - action string or unicode - any built-in function to perform.
/// @param replaceItems [opt] bool - Deprecated!
///
///
/// List of functions - http://kodi.wiki/view/List_of_Built_In_Functions
Expand All @@ -693,6 +695,7 @@ namespace XBMCAddon
///
///
///-----------------------------------------------------------------------
/// @python_v17 Completely removed option **replaceItems**.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
Expand Down Expand Up @@ -845,6 +848,8 @@ namespace XBMCAddon
/// listitem.setSubtitles(['special://temp/example.srt', 'http://example.com/example.srt'])
/// ...
/// ~~~~~~~~~~~~~
///-----------------------------------------------------------------------
/// @python_v14 New function added.
///
setSubtitles(...);
#else
Expand All @@ -856,7 +861,7 @@ namespace XBMCAddon
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getdescription() }
///-----------------------------------------------------------------------
/// @warning Deprecated.
/// @python_v17 Deprecated.
///
///
getdescription();
Expand All @@ -869,7 +874,7 @@ namespace XBMCAddon
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getduration() }
///-----------------------------------------------------------------------
/// @warning Deprecated.
/// @python_v17 Deprecated. Use **InfoTagMusic**.
///
///
getduration();
Expand All @@ -882,7 +887,7 @@ namespace XBMCAddon
/// \ingroup python_xbmcgui_listitem
/// @brief \python_func{ getfilename() }
///-----------------------------------------------------------------------
/// @warning Deprecated.
/// @python_v17 Deprecated.
///
///
getfilename();
Expand All @@ -898,6 +903,9 @@ namespace XBMCAddon
/// Returns the path of this listitem.
///
/// @return [string] filename
///-----------------------------------------------------------------------
/// @python_v17 New function added.
///
///
getPath();
#else
Expand Down
1 change: 1 addition & 0 deletions xbmc/interfaces/legacy/ModuleXbmc.h
Expand Up @@ -80,6 +80,7 @@ namespace XBMCAddon
///
///
/// ------------------------------------------------------------------------
/// @python_v17 Default level changed from LOGNOTICE to LOGDEBUG
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
Expand Down
12 changes: 9 additions & 3 deletions xbmc/interfaces/legacy/Monitor.h
Expand Up @@ -154,6 +154,8 @@ namespace XBMCAddon
///
/// @note Will be called when library clean has ended and return video or
/// music to indicate which library is being scanned
///-----------------------------------------------------------------------
/// @python_v14 New function added.
///
onScanStarted(...);
#else
Expand All @@ -172,6 +174,8 @@ namespace XBMCAddon
///
/// @note Will be called when library clean has ended and return video or
/// music to indicate which library has been scanned
///-----------------------------------------------------------------------
/// @python_v14 New function added.
///
onScanFinished(...);
#else
Expand All @@ -183,7 +187,7 @@ namespace XBMCAddon
/// \ingroup python_monitor
/// @brief \python_func{ onDatabaseScanStarted(database) }
///-----------------------------------------------------------------------
/// @warning Deprecated, use onScanStarted().
/// @python_v14 Deprecated. Use **onScanStarted()**.
///
onDatabaseScanStarted(...);
#else
Expand All @@ -195,7 +199,7 @@ namespace XBMCAddon
/// \ingroup python_monitor
/// @brief \python_func{ onDatabaseUpdated(database) }
///-----------------------------------------------------------------------
/// @warning Deprecated, use onScanFinished().
/// @python_v14 Deprecated. Use **onScanFinished()**.
///
onDatabaseUpdated(...);
#else
Expand Down Expand Up @@ -243,7 +247,7 @@ namespace XBMCAddon
/// \ingroup python_monitor
/// @brief \python_func{ onAbortRequested() }
///-----------------------------------------------------------------------
/// @warning Deprecated, use waitForAbort() to be notified about this event.
/// @python_v14 Deprecated. Use **waitForAbort()** to be notified about this event.
///
onAbortRequested();
#else
Expand Down Expand Up @@ -285,6 +289,8 @@ namespace XBMCAddon
/// @return True when abort have been requested,
/// False if a timeout is given and the
/// operation times out.
///-----------------------------------------------------------------------
/// @python_v14 New function added.
///
waitForAbort(...);
#else
Expand Down
10 changes: 10 additions & 0 deletions xbmc/interfaces/legacy/Player.h
Expand Up @@ -498,6 +498,16 @@ namespace XBMCAddon
void showSubtitles(bool bVisible);
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Player
/// @brief \python_func{ DisableSubtitles() }
///-----------------------------------------------------------------------
/// @python_v12 Deprecated. Use **showSubtitles** instead.
/// @python_v17 Completely removed function.
///
#endif

#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Player
Expand Down

0 comments on commit c97066c

Please sign in to comment.