Title: [221847] trunk
- Revision
- 221847
- Author
- [email protected]
- Date
- 2017-09-10 23:14:23 -0700 (Sun, 10 Sep 2017)
Log 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.
Modified Paths
Diff
Modified: trunk/Source/WebKit/ChangeLog (221846 => 221847)
--- trunk/Source/WebKit/ChangeLog 2017-09-11 05:59:32 UTC (rev 221846)
+++ trunk/Source/WebKit/ChangeLog 2017-09-11 06:14:23 UTC (rev 221847)
@@ -1,3 +1,19 @@
+2017-09-10 Carlos Garcia Campos <[email protected]>
+
+ 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 <[email protected]>
Try to avoid creating the default WKWebsiteDataStore until its actually needed.
Modified: trunk/Source/WebKit/UIProcess/API/glib/WebKitSettings.cpp (221846 => 221847)
--- trunk/Source/WebKit/UIProcess/API/glib/WebKitSettings.cpp 2017-09-11 05:59:32 UTC (rev 221846)
+++ trunk/Source/WebKit/UIProcess/API/glib/WebKitSettings.cpp 2017-09-11 06:14:23 UTC (rev 221847)
@@ -849,7 +849,7 @@
* 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,
Modified: trunk/Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp (221846 => 221847)
--- trunk/Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp 2017-09-11 05:59:32 UTC (rev 221846)
+++ trunk/Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp 2017-09-11 06:14:23 UTC (rev 221847)
@@ -1633,7 +1633,7 @@
* 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 @@
* 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",
Modified: trunk/Source/WebKit/UIProcess/API/glib/WebKitWebsiteDataManager.cpp (221846 => 221847)
--- trunk/Source/WebKit/UIProcess/API/glib/WebKitWebsiteDataManager.cpp 2017-09-11 05:59:32 UTC (rev 221846)
+++ trunk/Source/WebKit/UIProcess/API/glib/WebKitWebsiteDataManager.cpp 2017-09-11 06:14:23 UTC (rev 221847)
@@ -434,7 +434,7 @@
* 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.
*
Modified: trunk/Source/WebKit/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml (221846 => 221847)
--- trunk/Source/WebKit/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml 2017-09-11 05:59:32 UTC (rev 221846)
+++ trunk/Source/WebKit/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml 2017-09-11 06:14:23 UTC (rev 221847)
@@ -125,7 +125,7 @@
<index id="api-index-2-18" role="2.18">
<title>Index of new symbols in 2.18</title>
<xi:include href="" /></xi:include>
- </index>
+ </index>
<xi:include href="" /></xi:include>
</book>
Modified: trunk/Tools/ChangeLog (221846 => 221847)
--- trunk/Tools/ChangeLog 2017-09-11 05:59:32 UTC (rev 221846)
+++ trunk/Tools/ChangeLog 2017-09-11 06:14:23 UTC (rev 221847)
@@ -1,3 +1,21 @@
+2017-09-10 Carlos Garcia Campos <[email protected]>
+
+ 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 <[email protected]>
WSL should support while loops
Modified: trunk/Tools/gtk/generate-gtkdoc (221846 => 221847)
--- trunk/Tools/gtk/generate-gtkdoc 2017-09-11 05:59:32 UTC (rev 221846)
+++ trunk/Tools/gtk/generate-gtkdoc 2017-09-11 06:14:23 UTC (rev 221847)
@@ -80,12 +80,15 @@
"""
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']:
_______________________________________________
webkit-changes mailing list
[email protected]
https://lists.webkit.org/mailman/listinfo/webkit-changes
