[processing] Allow help url to be set for models within help edit dialog

nyalldawson · nyalldawson · commit 844a3fb1b16e · 2018-09-26T04:26:49.000+10:00
Refs #18767
diff --git a/python/plugins/processing/gui/HelpEditionDialog.py b/python/plugins/processing/gui/HelpEditionDialog.py
@@ -53,6 +53,7 @@ class HelpEditionDialog(BASE, WIDGET):
     ALG_HELP_CREATOR = 'ALG_HELP_CREATOR'
     ALG_VERSION = 'ALG_VERSION'
     SHORT_DESCRIPTION = 'SHORT_DESCRIPTION'
+    HELP_URL = 'HELP_URL'
 
     def __init__(self, alg):
         super(HelpEditionDialog, self).__init__(None)
@@ -127,6 +128,9 @@ def fillTree(self):
         item = TreeDescriptionItem(self.tr('Algorithm version'),
                                    self.ALG_VERSION)
         self.tree.addTopLevelItem(item)
+        item = TreeDescriptionItem(self.tr('Documentation help URL'),
+                                   self.HELP_URL)
+        self.tree.addTopLevelItem(item)
 
     def changeItem(self):
         item = self.tree.currentItem()
diff --git a/src/core/processing/models/qgsprocessingmodelalgorithm.cpp b/src/core/processing/models/qgsprocessingmodelalgorithm.cpp
@@ -83,7 +83,7 @@ QString QgsProcessingModelAlgorithm::shortDescription() const
 
 QString QgsProcessingModelAlgorithm::helpUrl() const
 {
-  return QString();
+  return mHelpContent.value( QStringLiteral( "HELP_URL" ) ).toString();
 }
 
 QgsProcessingAlgorithm::Flags QgsProcessingModelAlgorithm::flags() const
diff --git a/tests/src/analysis/testqgsprocessing.cpp b/tests/src/analysis/testqgsprocessing.cpp
@@ -5661,6 +5661,18 @@ void TestQgsProcessing::modelerAlgorithm()
   alg.setGroup( QStringLiteral( "group2" ) );
   QCOMPARE( alg.group(), QStringLiteral( "group2" ) );
 
+  QVariantMap help;
+  alg.setHelpContent( help );
+  QVERIFY( alg.helpContent().isEmpty() );
+  QVERIFY( alg.helpUrl().isEmpty() );
+  QVERIFY( alg.shortDescription().isEmpty() );
+  help.insert( QStringLiteral( "SHORT_DESCRIPTION" ), QStringLiteral( "short" ) );
+  help.insert( QStringLiteral( "HELP_URL" ), QStringLiteral( "url" ) );
+  alg.setHelpContent( help );
+  QCOMPARE( alg.helpContent(), help );
+  QCOMPARE( alg.shortDescription(), QStringLiteral( "short" ) );
+  QCOMPARE( alg.helpUrl(), QStringLiteral( "url" ) );
+
   // child algorithms
   QMap<QString, QgsProcessingModelChildAlgorithm> algs;
   QgsProcessingModelChildAlgorithm a1;

Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ QString QgsProcessingModelAlgorithm::shortDescription() const`
`83`	`83`
`84`	`84`	`QString QgsProcessingModelAlgorithm::helpUrl() const`
`85`	`85`	`{`
`86`		`- return QString();`
	`86`	`+ return mHelpContent.value( QStringLiteral( "HELP_URL" ) ).toString();`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`QgsProcessingAlgorithm::Flags QgsProcessingModelAlgorithm::flags() const`