Doc: Fix template information for a QList constructor
When QDoc parses a project, it parses the source code to extract the user-provided documentation and perform sanity checkings based on the code itself on it. When QDoc parses an "\fn" command as part of this process, it tries to understand, based on its intermediate representation built on the information extracted from the code-base, which "documentable element" the "\fn" refers to. When QDoc performs this "matching" process, it takes into consideration only a certain amount of information. For example, no checking is performed over the template declaration of a callable. Due to some upcoming documentation, where two callables are indistinguishable to the current process, as they differ only in their template declaration, QDoc will start to take into consideration the template declaration of a callable when matching. This implies that an "\fn" command should now provide information parity, with regards to template declaration for callables, with the code-base so that QDoc can perform the match correctly. The documentation for `QList::QList(InputIterator, InputIterator)` is not in sync with the intended target template declaration. Hence, add the missing information to the relevant "\fn" command. Task-number: QTBUG-118080 Change-Id: I576a3b71ba39cec0d51f08f7db9771401e1fa340 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>bb10
parent
43aecf7dde
commit
a180dc5e27
|
|
@ -274,7 +274,7 @@
|
|||
Constructs a list from the std::initializer_list given by \a args.
|
||||
*/
|
||||
|
||||
/*! \fn template <typename T> template<typename InputIterator, if_input_iterator<InputIterator>> QList<T>::QList(InputIterator first, InputIterator last)
|
||||
/*! \fn template<typename T> template <typename InputIterator, if_input_iterator<InputIterator> = true> QList<T>::QList(InputIterator first, InputIterator last)
|
||||
\since 5.14
|
||||
|
||||
Constructs a list with the contents in the iterator range [\a first, \a last).
|
||||
|
|
|
|||
Loading…
Reference in New Issue