[Libreoffice-commits] core.git: wizards/source

Jean-Pierre Ledure (via logerrit) logerrit at kemper.freedesktop.org
Thu Jun 17 12:41:32 UTC 2021 

 wizards/source/scriptforge/SF_Array.xba          |    3 +++
 wizards/source/scriptforge/SF_Dictionary.xba     |    3 +++
 wizards/source/scriptforge/SF_Exception.xba      |    2 ++
 wizards/source/scriptforge/SF_FileSystem.xba     |    3 +++
 wizards/source/scriptforge/SF_L10N.xba           |    3 +++
 wizards/source/scriptforge/SF_Platform.xba       |    3 +++
 wizards/source/scriptforge/SF_Services.xba       |    3 +++
 wizards/source/scriptforge/SF_Session.xba        |    3 +++
 wizards/source/scriptforge/SF_String.xba         |    3 +++
 wizards/source/scriptforge/SF_TextStream.xba     |    3 +++
 wizards/source/scriptforge/SF_Timer.xba          |    3 +++
 wizards/source/scriptforge/SF_UI.xba             |    5 ++++-
 wizards/source/scriptforge/python/scriptforge.py |    3 +++
 wizards/source/sfdatabases/SF_Database.xba       |    2 ++
 wizards/source/sfdialogs/SF_Dialog.xba           |    3 +++
 wizards/source/sfdialogs/SF_DialogControl.xba    |    3 +++
 wizards/source/sfdocuments/SF_Base.xba           |    3 +++
 wizards/source/sfdocuments/SF_Calc.xba           |    3 +++
 wizards/source/sfdocuments/SF_Document.xba       |    3 +++
 wizards/source/sfdocuments/SF_Form.xba           |    3 +++
 wizards/source/sfdocuments/SF_FormControl.xba    |    3 +++
 21 files changed, 62 insertions(+), 1 deletion(-)

New commits:
commit 2a38a064dfcb56cd887dc672b4d3bd260570ef13
Author:     Jean-Pierre Ledure <jp at ledure.be>
AuthorDate: Thu Jun 17 11:27:34 2021 +0200
Commit:     Jean-Pierre Ledure <jp at ledure.be>
CommitDate: Thu Jun 17 14:40:49 2021 +0200

    ScriptForge - Comments in code: pointers to help pages
    
    Insert in each service module a pointer to the
    help page on https://help.libreoffice.org
    containing the user documentation of the given
    service.
    
    Example:
    SF_Array.xba contains a pointer to next help page
    https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_array.html?DbPAR=BASIC
    
    Only addition of comments lines.
    No code change.
    
    Change-Id: I83899d9fab247d23e2d5123378e2fb3fd0ade60e
    Reviewed-on: https://gerrit.libreoffice.org/c/core/+/117370
    Tested-by: Jean-Pierre Ledure <jp at ledure.be>
    Tested-by: Jenkins
    Reviewed-by: Jean-Pierre Ledure <jp at ledure.be>

diff --git a/wizards/source/scriptforge/SF_Array.xba b/wizards/source/scriptforge/SF_Array.xba
index ea1500bdd057..9930574b6b10 100644
--- a/wizards/source/scriptforge/SF_Array.xba
+++ b/wizards/source/scriptforge/SF_Array.xba
@@ -17,6 +17,9 @@ Option Explicit
 '''			With the noticeable exception of the CountDims method (>2 dims allowed)
 '''		The first argument of almost every method is the array to consider
 '''			It is always passed by reference and left unchanged
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_array.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/scriptforge/SF_Dictionary.xba b/wizards/source/scriptforge/SF_Dictionary.xba
index de10ed45fd4d..9fb84de55418 100644
--- a/wizards/source/scriptforge/SF_Dictionary.xba
+++ b/wizards/source/scriptforge/SF_Dictionary.xba
@@ -30,6 +30,9 @@ Option Explicit
 '''		Service instantiation example:
 '''			Dim myDict As Variant
 '''			myDict = CreateScriptService("Dictionary")		'	Once per dictionary
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_dictionary.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/scriptforge/SF_Exception.xba b/wizards/source/scriptforge/SF_Exception.xba
index 6bdf9908a411..9b26466aa818 100644
--- a/wizards/source/scriptforge/SF_Exception.xba
+++ b/wizards/source/scriptforge/SF_Exception.xba
@@ -38,6 +38,8 @@ Option Explicit
 '''			2,	Inform the user about the error with either a standard or a customized message
 '''			3.	Optionally, stop the execution of the current macro
 '''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_exception.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/scriptforge/SF_FileSystem.xba b/wizards/source/scriptforge/SF_FileSystem.xba
index 11ec24c67a61..4551caf4973e 100644
--- a/wizards/source/scriptforge/SF_FileSystem.xba
+++ b/wizards/source/scriptforge/SF_FileSystem.xba
@@ -40,6 +40,9 @@ Option Explicit
 '''		Service invocation example:
 '''			Dim FSO As Variant
 '''			Set FSO = CreateScriptService("FileSystem")
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_filesystem.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/scriptforge/SF_L10N.xba b/wizards/source/scriptforge/SF_L10N.xba
index ced25a25bc78..28da6c4c34d6 100644
--- a/wizards/source/scriptforge/SF_L10N.xba
+++ b/wizards/source/scriptforge/SF_L10N.xba
@@ -55,6 +55,9 @@ Option Explicit
 '''			myPO = CreateScriptService("L10N")	'	AddText and ExportToPOTFile are allowed
 '''			myPO = CreateScriptService("L10N", "C:\myPOFiles\", "fr-BE")
 '''				'All functionalities are available
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_l10n.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM =============================================================== PRIVATE TYPES
diff --git a/wizards/source/scriptforge/SF_Platform.xba b/wizards/source/scriptforge/SF_Platform.xba
index 69045404b5ba..919a8901641d 100644
--- a/wizards/source/scriptforge/SF_Platform.xba
+++ b/wizards/source/scriptforge/SF_Platform.xba
@@ -23,6 +23,9 @@ Option Explicit
 '''		Service invocation example:
 '''			Dim platform As Variant
 '''			platform = CreateScriptService("Platform")
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_platform.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/scriptforge/SF_Services.xba b/wizards/source/scriptforge/SF_Services.xba
index 39429d67384e..2ae92b79bc2a 100644
--- a/wizards/source/scriptforge/SF_Services.xba
+++ b/wizards/source/scriptforge/SF_Services.xba
@@ -28,6 +28,9 @@ Option Explicit
 '''				Register a single event manager
 '''			- CreateScriptService
 '''				Called by user scripts to get an object giving access to a service or to the event manager
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_services.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/scriptforge/SF_Session.xba b/wizards/source/scriptforge/SF_Session.xba
index 182fe1049f0b..837c26b2a048 100644
--- a/wizards/source/scriptforge/SF_Session.xba
+++ b/wizards/source/scriptforge/SF_Session.xba
@@ -23,6 +23,9 @@ Option Explicit
 '''		Service invocation example:
 '''			Dim session As Variant
 '''			session = CreateScriptService("Session")
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_session.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/scriptforge/SF_String.xba b/wizards/source/scriptforge/SF_String.xba
index f7c645981c8b..6eb78b67ce0c 100644
--- a/wizards/source/scriptforge/SF_String.xba
+++ b/wizards/source/scriptforge/SF_String.xba
@@ -36,6 +36,9 @@ Option Explicit
 '''		Not printable characters:
 '''			Defined in the Unicode character database as “Other” or “Separator”
 '''			In particular, "control" characters (ascii code <= 0x1F) are not printable
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_string.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 '''	Some references:
 '''		https://api.libreoffice.org/docs/idl/ref/namespacecom_1_1sun_1_1star_1_1i18n_1_1KCharacterType.html
diff --git a/wizards/source/scriptforge/SF_TextStream.xba b/wizards/source/scriptforge/SF_TextStream.xba
index 827c5e303344..35f1b6fb2b49 100644
--- a/wizards/source/scriptforge/SF_TextStream.xba
+++ b/wizards/source/scriptforge/SF_TextStream.xba
@@ -35,6 +35,9 @@ Option Explicit
 '''			Dim FSO As Object, myFile As Object
 '''				Set FSO = CreateScriptService("FileSystem")
 '''				Set myFile = FSO.OpenTextFile("C:\Temp\ThisFile.txt", FSO.ForReading)	'	Once per file
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_textstream.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/scriptforge/SF_Timer.xba b/wizards/source/scriptforge/SF_Timer.xba
index f1c718fca7b1..2b3286e041ab 100644
--- a/wizards/source/scriptforge/SF_Timer.xba
+++ b/wizards/source/scriptforge/SF_Timer.xba
@@ -21,6 +21,9 @@ Option Explicit
 '''			Dim myTimer As Variant
 '''			myTimer = CreateScriptService("Timer")
 '''			myTimer = CreateScriptService("Timer", True)	'	=> To start timer immediately
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_timer.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/scriptforge/SF_UI.xba b/wizards/source/scriptforge/SF_UI.xba
index c865c703e8b4..9b98053a85c9 100644
--- a/wizards/source/scriptforge/SF_UI.xba
+++ b/wizards/source/scriptforge/SF_UI.xba
@@ -30,7 +30,10 @@ Option Explicit
 '''		Service invocation example:
 '''			Dim ui As Variant
 '''			ui = CreateScriptService("UI")
-
+'''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_ui.html?DbPAR=BASIC
+'''
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/scriptforge/python/scriptforge.py b/wizards/source/scriptforge/python/scriptforge.py
index 18f70e492098..d2126b435126 100644
--- a/wizards/source/scriptforge/python/scriptforge.py
+++ b/wizards/source/scriptforge/python/scriptforge.py
@@ -611,6 +611,9 @@ class SFScriptForge:
 
             The signatures of Basic builtin functions are derived from
                 core/basic/source/runtime/stdobj.cxx
+
+            Detailed user documentation:
+                https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_basic.html?DbPAR=BASIC
             """
         # Mandatory class properties for service registration
         serviceimplementation = 'python'
diff --git a/wizards/source/sfdatabases/SF_Database.xba b/wizards/source/sfdatabases/SF_Database.xba
index bcbaba82d8f5..a03f90e6ee55 100644
--- a/wizards/source/sfdatabases/SF_Database.xba
+++ b/wizards/source/sfdatabases/SF_Database.xba
@@ -45,6 +45,8 @@ Option Explicit
 '''				'	... Run queries, SQL statements, ...
 '''				myDoc.CloseDocument()
 '''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_database.html?DbPAR=BASIC
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/sfdialogs/SF_Dialog.xba b/wizards/source/sfdialogs/SF_Dialog.xba
index e0b7beb11d0a..a574cf87ef25 100644
--- a/wizards/source/sfdialogs/SF_Dialog.xba
+++ b/wizards/source/sfdialogs/SF_Dialog.xba
@@ -42,6 +42,9 @@ Option Explicit
 '''				End If
 '''				myDialog.Terminate()
 '''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_dialog.html?DbPAR=BASIC
+'''
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/sfdialogs/SF_DialogControl.xba b/wizards/source/sfdialogs/SF_DialogControl.xba
index ab32abbd484f..71ef6a3ce201 100644
--- a/wizards/source/sfdialogs/SF_DialogControl.xba
+++ b/wizards/source/sfdialogs/SF_DialogControl.xba
@@ -38,6 +38,9 @@ Option Explicit
 '''				'	... process the controls actual values
 '''				myDialog.Terminate()
 '''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_dialogcontrol.html?DbPAR=BASIC
+'''
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/sfdocuments/SF_Base.xba b/wizards/source/sfdocuments/SF_Base.xba
index f0310d0da48a..87d95152a24e 100644
--- a/wizards/source/sfdocuments/SF_Base.xba
+++ b/wizards/source/sfdocuments/SF_Base.xba
@@ -43,6 +43,9 @@ Option Explicit
 '''			Set oDoc = CreateScriptService("SFDocuments.Base", "MyFile.odb")
 '''			' The substring "SFDocuments." in the service name is optional
 '''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_base.html?DbPAR=BASIC
+'''
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/sfdocuments/SF_Calc.xba b/wizards/source/sfdocuments/SF_Calc.xba
index e4bf084c8b83..1b96a981ec3a 100644
--- a/wizards/source/sfdocuments/SF_Calc.xba
+++ b/wizards/source/sfdocuments/SF_Calc.xba
@@ -71,6 +71,9 @@ Option Explicit
 '''					myDoc.Range("SheetX.D2:F6")
 '''											A range within the sheet SheetX in file associated with the myDoc Calc instance
 '''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_calc.html?DbPAR=BASIC
+'''
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/sfdocuments/SF_Document.xba b/wizards/source/sfdocuments/SF_Document.xba
index b4d3edbe915a..3894d0fccb5b 100644
--- a/wizards/source/sfdocuments/SF_Document.xba
+++ b/wizards/source/sfdocuments/SF_Document.xba
@@ -46,6 +46,9 @@ Option Explicit
 '''			Set oDoc = CreateScriptService("SFDocuments.Document", "Untitled 1")	'	Default = ActiveWindow
 '''				' The substring "SFDocuments." in the service name is optional
 '''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_document.html?DbPAR=BASIC
+'''
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/sfdocuments/SF_Form.xba b/wizards/source/sfdocuments/SF_Form.xba
index c563bb302a57..93beee283c37 100644
--- a/wizards/source/sfdocuments/SF_Form.xba
+++ b/wizards/source/sfdocuments/SF_Form.xba
@@ -65,6 +65,9 @@ Option Explicit
 '''			Dim myForm As Object
 '''				Set myForm = CreateScriptService("SFDocuments.FormEvent", poEvent)
 '''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_form.html?DbPAR=BASIC
+'''
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS
diff --git a/wizards/source/sfdocuments/SF_FormControl.xba b/wizards/source/sfdocuments/SF_FormControl.xba
index 92055c5e25a4..f08506d36226 100644
--- a/wizards/source/sfdocuments/SF_FormControl.xba
+++ b/wizards/source/sfdocuments/SF_FormControl.xba
@@ -37,6 +37,9 @@ Option Explicit
 '''			Dim myControl As Object
 '''				Set myControl = CreateScriptService("SFDocuments.FormEvent", poEvent)
 '''
+'''		Detailed user documentation:
+'''			https://help.libreoffice.org/latest/en-US/text/sbasic/shared/03/sf_formcontrol.html?DbPAR=BASIC
+'''
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 REM ================================================================== EXCEPTIONS

More information about the Libreoffice-commits mailing list