Convert enum value comments from doxygen syntax to sphinx syntax

oaubert · Oct 7, 2024 · 4460637 · 4460637
1 parent d21b55e
commit 4460637
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 7 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -46,6 +46,7 @@
 autoapi_member_order = 'alphabetical'
 autoapi_own_page_level = 'class'
 autoapi_python_class_content = 'both'
+autoapi_options = [ 'members', 'undoc-members', 'private-members', 'show-inheritance', 'show-module-summary' ]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

diff --git a/generated/3.0/vlc.py b/generated/3.0/vlc.py
@@ -52,10 +52,10 @@
 
 logger = logging.getLogger(__name__)
 
-__version__ = "3.0.21202"
+__version__ = "3.0.21203"
 __libvlc_version__ = "3.0.21"
-__generator_version__ = "2.2"
-build_date = "Mon Oct  7 14:14:00 2024 3.0.21"
+__generator_version__ = "2.3"
+build_date = "Mon Oct  7 16:36:40 2024 3.0.21"
 
 # The libvlc doc states that filenames are expected to be in UTF8, do
 # not rely on sys.getfilesystemencoding() which will be confused,
@@ -3950,9 +3950,11 @@ class EventType(_Enum):
       * ``vlc.EventType.MediaListPlayerPlayed``
       * ``vlc.EventType.MediaListPlayerNextItemSet``
       * ``vlc.EventType.MediaListPlayerStopped``
-      * ``vlc.EventType.MediaDiscovererStarted`` \deprecated Useless event, it will be triggered only when calling
+      * ``vlc.EventType.MediaDiscovererStarted``
+    .. warning:: **Deprecated!** Useless event, it will be triggered only when calling
     libvlc_media_discoverer_start()
-      * ``vlc.EventType.MediaDiscovererEnded`` \deprecated Useless event, it will be triggered only when calling
+      * ``vlc.EventType.MediaDiscovererEnded``
+    .. warning:: **Deprecated!** Useless event, it will be triggered only when calling
     libvlc_media_discoverer_stop()
       * ``vlc.EventType.RendererDiscovererItemAdded``
       * ``vlc.EventType.RendererDiscovererItemDeleted``

diff --git a/generator/generate.py b/generator/generate.py
@@ -51,7 +51,7 @@
 
 # Version number MUST have a major < 10 and a minor < 99 so that the
 # generated dist version can be correctly generated (major * 100 + minor).
-__version__ = "2.2"
+__version__ = "2.3"
 
 _debug = False
 
@@ -2283,7 +2283,10 @@ def generate_enums(self):
             # Add names in generated docstring
             # so that they are available in Sphinx-generated doc
             symbols = _NL_.join(
-                [f"  * ``vlc.{cls}.{v.name}`` { v.docs }" for v in e.vals]
+                [
+                    f"  * ``vlc.{cls}.{v.name}`` { "\n".join(e.base_sphinx_format(v.docs)) }"
+                    for v in e.vals
+                ]
             )
             docs = f"""{docs}