REGRESSION: [GTK] Generated HTML API documentation is missing descriptions
authorcarlosgc@webkit.org <carlosgc@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Mon, 11 Sep 2017 06:14:23 +0000 (06:14 +0000)
committercarlosgc@webkit.org <carlosgc@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Mon, 11 Sep 2017 06:14:23 +0000 (06:14 +0000)
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.

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

Source/WebKit/ChangeLog
Source/WebKit/UIProcess/API/glib/WebKitSettings.cpp
Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp
Source/WebKit/UIProcess/API/glib/WebKitWebsiteDataManager.cpp
Source/WebKit/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml
Tools/ChangeLog
Tools/gtk/generate-gtkdoc

index 97282b8..1582163 100644 (file)
@@ -1,3 +1,19 @@
+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>
 
         Try to avoid creating the default WKWebsiteDataStore until its actually needed.
index afef893..3ab45ab 100644 (file)
@@ -849,7 +849,7 @@ static void webkit_settings_class_init(WebKitSettingsClass* klass)
      * Determines whether or not private browsing is enabled. Private browsing
      * 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,
                                     PROP_ENABLE_PRIVATE_BROWSING,
index a773d3f..c4bd1c2 100644 (file)
@@ -1633,7 +1633,7 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
      * the menu.
      * </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>
      * </itemizedlist>
@@ -1862,7 +1862,7 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
      * Returns: %TRUE to stop other handlers from being invoked for the event.
      *   %FALSE to propagate the event further.
      *
-     * Since: 2.18.
+     * Since: 2.18
      */
     signals[SHOW_OPTION_MENU] = g_signal_new(
         "show-option-menu",
index c5cdedb..785bd71 100644 (file)
@@ -434,7 +434,7 @@ WebKitWebsiteDataManager* webkit_website_data_manager_new_ephemeral()
  * webkit_website_data_manager_is_ephemeral:
  * @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.
  *
index 7c1d545..3597152 100644 (file)
   <index id="api-index-2-18" role="2.18">
     <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>
 </book>
index 8aa3d86..97e3659 100644 (file)
@@ -1,3 +1,21 @@
+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>
 
         WSL should support while loops
index 33b2824..dbe2f9a 100755 (executable)
@@ -80,12 +80,15 @@ def files_to_ignore(source_dirs, headers_with_gtkdoc):
     """
     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):
         if os.path.splitext(file)[1] not in ['.h', '.c', '.cpp', '.cc']: