Changeset 221847 in webkit

Timestamp:

Sep 10, 2017 11:14:23 PM (7 years ago)

Author:

Carlos Garcia Campos

Message:

REGRESSION: [GTK] Generated HTML API documentation is missing descriptions
​https://bugs.webkit.org/show_bug.cgi?id=176667

Reviewed by Michael Catanzaro.

Source/WebKit:

Fix several typos in API documentation.

• UIProcess/API/glib/WebKitSettings.cpp:

(webkit_settings_class_init):

• UIProcess/API/glib/WebKitWebView.cpp:

(webkit_web_view_class_init):

• UIProcess/API/glib/WebKitWebsiteDataManager.cpp:
• UIProcess/API/gtk/docs/webkit2gtk-docs.sgml:

Tools:

This is happening since we moved the implementation files to glib dirs. The generate-gtkdoc script assumes that
header and implementation files are always in the same directory. To reduce the input we pass to gtk-doc we
ignore cpp files for which there isn't a public header. The code to do this check doesn't consider cpp files in
a different directory than the header file. It also assumes that header and cpp files have the same filename
except for the extension, which is true in all cases but WebKitWebView that we have two files WebKitWebView.cpp
and WebKitWebViewGtk.cpp.

• gtk/generate-gtkdoc:

(files_to_ignore): Check also cpp files with the Gtk suffix.
(files_to_ignore.add_file_if_exists): Check if a file with the given name exists in any of the source dirs.

Location:

trunk

Files:

• Source/WebKit/ChangeLog (modified) (1 diff)
• Source/WebKit/UIProcess/API/glib/WebKitSettings.cpp (modified) (1 diff)
• Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp (modified) (2 diffs)
• Source/WebKit/UIProcess/API/glib/WebKitWebsiteDataManager.cpp (modified) (1 diff)
• Source/WebKit/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/gtk/generate-gtkdoc (modified) (1 diff)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2017-09-10  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        REGRESSION: [GTK] Generated HTML API documentation is missing descriptions
+        https://bugs.webkit.org/show_bug.cgi?id=176667
+
+        Reviewed by Michael Catanzaro.
+
+        Fix several typos in API documentation.
+
+        * UIProcess/API/glib/WebKitSettings.cpp:
+        (webkit_settings_class_init):
+        * UIProcess/API/glib/WebKitWebView.cpp:
+        (webkit_web_view_class_init):
+        * UIProcess/API/glib/WebKitWebsiteDataManager.cpp:
+        * UIProcess/API/gtk/docs/webkit2gtk-docs.sgml:
+
 2017-09-10  Brady Eidson  <beidson@apple.com>
 

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

@@ -850 +850 @@
      * will disable history, cache and form auto-fill for any pages visited.
      *
-     * Deprecated: 2.16. Use #WebKitWebView:is-ephemeral or #WebKitWebContext:is-ephemeral instead.
+     * Deprecated: 2.16. Use #WebKitWebView:is-ephemeral or #WebKitWebsiteDataManager:is-ephemeral instead.
      */
     g_object_class_install_property(gObjectClass,

trunk/Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp

@@ -1634 +1634 @@
      * </para></listitem>
      * <listitem><para>
-     * a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget:popup-menu
+     * a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu
      * signal was used to show the context menu.
      * </para></listitem>
@@ -1863 +1863 @@
      *   %FALSE to propagate the event further.
      *
-     * Since: 2.18.
+     * Since: 2.18
      */
     signals[SHOW_OPTION_MENU] = g_signal_new(

trunk/Source/WebKit/UIProcess/API/glib/WebKitWebsiteDataManager.cpp

@@ -435 +435 @@
  * @manager: a #WebKitWebsiteDataManager
  *
- * Get whether a #WebKitWebsiteDataManager is ephemeral. See #WebKitWebsiteDataManager::is-ephemerla for more details.
+ * Get whether a #WebKitWebsiteDataManager is ephemeral. See #WebKitWebsiteDataManager:is-ephemeral for more details.
  *
  * Returns: %TRUE if @manager is epheral or %FALSE otherwise.

trunk/Source/WebKit/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml

@@ -126 +126 @@
     <title>Index of new symbols in 2.18</title>
     <xi:include href="xml/api-index-2.18.xml"><xi:fallback /></xi:include>
-    </index>
+  </index>
 
   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>

trunk/Tools/ChangeLog

@@ +1 @@
+2017-09-10  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        REGRESSION: [GTK] Generated HTML API documentation is missing descriptions
+        https://bugs.webkit.org/show_bug.cgi?id=176667
+
+        Reviewed by Michael Catanzaro.
+
+        This is happening since we moved the implementation files to glib dirs. The generate-gtkdoc script assumes that
+        header and implementation files are always in the same directory. To reduce the input we pass to gtk-doc we
+        ignore cpp files for which there isn't a public header. The code to do this check doesn't consider cpp files in
+        a different directory than the header file. It also assumes that header and cpp files have the same filename
+        except for the extension, which is true in all cases but WebKitWebView that we have two files WebKitWebView.cpp
+        and WebKitWebViewGtk.cpp.
+
+        * gtk/generate-gtkdoc:
+        (files_to_ignore): Check also cpp files with the Gtk suffix.
+        (files_to_ignore.add_file_if_exists): Check if a file with the given name exists in any of the source dirs.
+
 2017-09-10  Myles C. Maxfield  <mmaxfield@apple.com>
 

trunk/Tools/gtk/generate-gtkdoc

@@ -81 +81 @@
     implementation_files = list(headers_with_gtkdoc)
     for header in headers_with_gtkdoc:
-        def add_file_if_exists(file):
-            if os.path.isfile(file):
-                implementation_files.append(os.path.abspath(file))
-        header_name_without_extension = os.path.splitext(header)[0]
-        add_file_if_exists(header_name_without_extension + ".cpp")
-        add_file_if_exists(header_name_without_extension + ".c")
+        def add_file_if_exists(filename):
+            for dir in source_dirs:
+                file = os.path.join(dir, filename)
+                if os.path.isfile(file):
+                    implementation_files.append(os.path.abspath(file))
+        header_basename_without_extension = os.path.splitext(os.path.basename(header))[0]
+        add_file_if_exists(header_basename_without_extension + ".cpp")
+        add_file_if_exists(header_basename_without_extension + "Gtk.cpp")
+        add_file_if_exists(header_basename_without_extension + ".c")
 
     def file_should_be_ignored(file):