optional-qtwebengine-05-98482ee0ebae1021655d9a6beb8c6b8a5f62605a

commit 98482ee0ebae1021655d9a6beb8c6b8a5f62605a
Author: Nathan Ho <nathan@snappizz.com>
Date:   Sun Jun 2 01:43:38 2019 -0700

    help: Expand docs for WebView/HelpBrowser

Gbp-Pq: Name optional-qtwebengine-05-98482ee0ebae1021655d9a6beb8c6b8a5f62605a

diff --git a/HelpSource/Classes/HelpBrowser.schelp b/HelpSource/Classes/HelpBrowser.schelp
index 768a8158c6827c106e967a2067d4e1713f4d24b1..c507afea0bbbbae73a3ab36e6c09dd014dfca5b5 100644 (file)
--- a/HelpSource/Classes/HelpBrowser.schelp
+++ b/HelpSource/Classes/HelpBrowser.schelp
@@ -7,6 +7,10 @@ description::
 
 HelpBrowser is the GUI help browser that lets you browse the documentation of SuperCollider. It is coupled with SCDoc to allow on-the-fly rendering of HTML help files.
 
+Note that this is not the same as the help browser built into the IDE.
+
+Since the Qt WebEngine dependency is hefty and difficult to install on some systems, it is possible for sclang to have been built without WebView support (using the CMake flag code:: -DQT_WEBENGINE=OFF :: at compile). If so, attempting to invoke this class will throw an error.
+
 classmethods::
 private:: getOldWrapUrl, initClass
 

diff --git a/HelpSource/Classes/WebView.schelp b/HelpSource/Classes/WebView.schelp
index 747155532a68486b9e6563de45b433f1b46d1593..d22bafb046bc3fb8e37650dcec3c01acce620bc2 100644 (file)
--- a/HelpSource/Classes/WebView.schelp
+++ b/HelpSource/Classes/WebView.schelp
@@ -6,6 +6,8 @@ DESCRIPTION::
 
 WebView displays web pages and provides all the standard browsing functionality.
 
+Since the Qt WebEngine dependency is hefty and difficult to install on some systems, it is possible for sclang to have been built without WebView support (using the CMake flag code:: -DQT_WEBENGINE=OFF :: at compile). If so, attempting to invoke this class will throw an error.
+
 CLASSMETHODS::
 
 PRIVATE:: key