From d1d98b6731cccca515f27c8cf2303b52d77a380c Mon Sep 17 00:00:00 2001 From: Thibaut Cuvelier Date: Wed, 13 Nov 2019 23:18:42 +0100 Subject: Change documentation as proposed by Edward Welbourne Change-Id: Ida9040a17e05b193974d39d72a9998c0a63ed892 Reviewed-by: Paul Wicking --- src/qdoc/generator.cpp | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'src/qdoc/generator.cpp') diff --git a/src/qdoc/generator.cpp b/src/qdoc/generator.cpp index 39c629465..080a290ae 100644 --- a/src/qdoc/generator.cpp +++ b/src/qdoc/generator.cpp @@ -971,9 +971,10 @@ void Generator::generateRequiredLinks(const Node *node, CodeMarker *marker) /*! Generates an external link to the project folder for example \a node. - The path to the example is appended to \a baseUrl string, or to a - specific location within the string marked with the placeholder '\1' - character. + The path to the example replaces a placeholder '\1' character if + one is found in the \a baseUrl string. If no such placeholder is found, + the path is appended to \a baseUrl, after a '/' character if \a baseUrl did + not already end in one. */ void Generator::generateLinkToExample(const ExampleNode *en, CodeMarker *marker, -- cgit v1.2.3