[GTK][WPE] Cannot build documentation with gtk-doc
authoraperez@igalia.com <aperez@igalia.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 7 May 2019 20:29:17 +0000 (20:29 +0000)
committeraperez@igalia.com <aperez@igalia.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 7 May 2019 20:29:17 +0000 (20:29 +0000)
https://bugs.webkit.org/show_bug.cgi?id=197663

Reviewed by Philippe Normand.

* UIProcess/API/glib/WebKitSettings.cpp:
(webkit_settings_class_init): Escape content which gets wrongly interpreted as
SGML tags by gtk-doc as Markdown preformatted content, which fits well for the
tag names in the documentation for the WebKitSettings:enable-media property.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@245027 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/WebKit/ChangeLog
Source/WebKit/UIProcess/API/glib/WebKitSettings.cpp

index 366fa6a..8f8a1d2 100644 (file)
@@ -1,3 +1,15 @@
+2019-05-07  Adrian Perez de Castro  <aperez@igalia.com>
+
+        [GTK][WPE] Cannot build documentation with gtk-doc
+        https://bugs.webkit.org/show_bug.cgi?id=197663
+
+        Reviewed by Philippe Normand.
+
+        * UIProcess/API/glib/WebKitSettings.cpp:
+        (webkit_settings_class_init): Escape content which gets wrongly interpreted as
+        SGML tags by gtk-doc as Markdown preformatted content, which fits well for the
+        tag names in the documentation for the WebKitSettings:enable-media property.
+
 2019-05-07  John Wilander  <wilander@apple.com>
 
         Storage Access API: Make two changes requested by developers and complete refactoring and cleanup
index 023b14c..657b1fe 100644 (file)
@@ -1505,7 +1505,7 @@ static void webkit_settings_class_init(WebKitSettingsClass* klass)
      * WebKitSettings:enable-media:
      *
      * Enable or disable support for media playback on pages. This setting is enabled by
-     * default. Disabling it means <audio>, <track> and <video> elements will have
+     * default. Disabling it means `<audio>`, `<track>` and `<video>` elements will have
      * playback support disabled.
      *
      * Since: 2.26