Improve documentation of value completion behaviour

This commit is contained in:
Martchus 2018-01-29 16:22:26 +01:00
parent 8c42a4644b
commit 2a797e436d
1 changed files with 6 additions and 0 deletions

View File

@ -753,6 +753,9 @@ inline bool Argument::isMainArgument() const
/*! /*!
* \brief Returns the items to be considered when generating completion for the values. * \brief Returns the items to be considered when generating completion for the values.
*
* By default, files and directories are considered, unless pre-defined values have been
* specified using setPreDefinedCompletionValues().
*/ */
inline ValueCompletionBehavior Argument::valueCompletionBehaviour() const inline ValueCompletionBehavior Argument::valueCompletionBehaviour() const
{ {
@ -761,6 +764,9 @@ inline ValueCompletionBehavior Argument::valueCompletionBehaviour() const
/*! /*!
* \brief Sets the items to be considered when generating completion for the values. * \brief Sets the items to be considered when generating completion for the values.
*
* By default, files and directories are considered, unless pre-defined values have been
* specified using setPreDefinedCompletionValues().
*/ */
inline void Argument::setValueCompletionBehavior(ValueCompletionBehavior completionValues) inline void Argument::setValueCompletionBehavior(ValueCompletionBehavior completionValues)
{ {