diff options
author | Topi Reinio <topi.reinio@qt.io> | 2023-02-07 10:47:28 +0000 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-02-24 04:47:52 +0000 |
commit | 9c24042178217e37c80bd1c92126ceba36ac2ef6 (patch) | |
tree | 53b5d6626706dbc7646ab7794825a68778b6a3ae | |
parent | ba48c52625b5a6ff9acf07754e66cca20b391762 (diff) |
qdoc: Drop remnants of unimplemented feature \generate examplefiles
Previously QDoc provided a \generatelist example[files|images] <regexp>
feature to list example files matching a specific regular expression,
but it was left non-functional after changes to example documentation
generation.
Remove remnants of the related code paths and documentation.
Change-Id: Ibdaab6e6be3e4d87b60fa59966783827f0a264e1
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
(cherry picked from commit b29500cbbe3cd115009331bd412ad4d4e49b524b)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/qdoc/doc/qdoc-manual-markupcmds.qdoc | 24 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-manual-topiccmds.qdoc | 3 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-warnings.qdoc | 7 | ||||
-rw-r--r-- | src/qdoc/docbookgenerator.cpp | 4 | ||||
-rw-r--r-- | src/qdoc/htmlgenerator.cpp | 8 |
5 files changed, 1 insertions, 45 deletions
diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc index b8a77c47e..123ab8a0d 100644 --- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc @@ -3497,30 +3497,6 @@ \note Support for this argument was introduced in QDoc 5.6. - \section2 \c {examplefiles [regular_expression]} - - The \c examplefiles argument lists the files that are part of - an example project. The optional second argument is a regular - expression; if provided, only the files whose path matches with - the regular expression are listed. - - The \c examplefiles argument can be only used within example - documentation (see \l {example-command}{\\example}), and is - typically used together with the \l {noautolist-command}{\\noautolist} - command. - - \section2 \c {exampleimages [regular_expression]} - - The \c exampleimages argument lists the images that are part of - an example project. The optional second argument is a regular - expression; if provided, only the image files whose path matches - with the regular expression are listed. - - The \c exampleimages argument can be only used within example - documentation (see \l {example-command}{\\example}), and is - typically used together with the \l {noautolist-command}{\\noautolist} - command. - \section2 \c functionindex The \c functionindex argument provides a complete alphabetical diff --git a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc index 4ca166d48..62e417ded 100644 --- a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc @@ -457,8 +457,7 @@ ... \endquotation - \b {See also:} \l {generatelist-command}{\\generatelist examplefiles}, - \l {noautolist-command}{\\noautolist}, + \b {See also:} \l {noautolist-command}{\\noautolist}, \l {url.examples-variable}{url.examples}, \l {meta-command}{\\meta} diff --git a/src/qdoc/doc/qdoc-warnings.qdoc b/src/qdoc/doc/qdoc-warnings.qdoc index bc68f39ab..25ac050b0 100644 --- a/src/qdoc/doc/qdoc-warnings.qdoc +++ b/src/qdoc/doc/qdoc-warnings.qdoc @@ -524,11 +524,6 @@ indexes += path/to/QtCreator/appmanplugin/manual.index \endcode - \section1 \\generatelist examplefiles can only be used with \\example topic command - - The command "\\generatelist examplefiles" can only be used in example - documentation (i.e., when the topic command is \\example). - \section1 \\generatelist <group> is empty Below a short overview of all possible arguments for \l {generatelist-command}{\\generatelist}: @@ -538,8 +533,6 @@ \li \\generatelist classes <prefix> \li \\generatelist classesbymodule <module name> \li \\generatelist qmltypesbymodule <module name> - \li \\generatelist examplesfiles <regular expression> - \li \\generatelist exampleimages <regular expression> \li \\generatelist functionindex \li \\generatelist legalese \li \\generatelist overviews diff --git a/src/qdoc/docbookgenerator.cpp b/src/qdoc/docbookgenerator.cpp index ad2e4bda9..2a2b9e1bb 100644 --- a/src/qdoc/docbookgenerator.cpp +++ b/src/qdoc/docbookgenerator.cpp @@ -475,10 +475,6 @@ qsizetype DocBookGenerator::generateAtom(const Atom *atom, const Node *relative) hasGeneratedSomething = !cn->members().isEmpty(); } } - } else if (atom->string().startsWith("examplefiles") - || atom->string().startsWith("exampleimages")) { - if (relative->isExample()) - qDebug() << "GENERATE FILE LIST CALLED" << relative->name() << atom->string(); } else if (atom->string() == QLatin1String("classhierarchy")) { generateClassHierarchy(relative, m_qdb->getCppClasses()); hasGeneratedSomething = !m_qdb->getCppClasses().isEmpty(); diff --git a/src/qdoc/htmlgenerator.cpp b/src/qdoc/htmlgenerator.cpp index 1793f8a12..fa9f98422 100644 --- a/src/qdoc/htmlgenerator.cpp +++ b/src/qdoc/htmlgenerator.cpp @@ -461,14 +461,6 @@ qsizetype HtmlGenerator::generateAtom(const Atom *atom, const Node *relative, Co } else generateAnnotatedList(relative, marker, cn->members()); } - } else if (atom->string().startsWith("examplefiles") - || atom->string().startsWith("exampleimages")) { - if (relative->isExample()) { - qDebug() << "GENERATE FILE LIST CALLED" << relative->name() << atom->string(); - } else - relative->location().warning(QString("'\\generatelist %1' can only be used with " - "'\\example' topic command") - .arg(atom->string())); } else if (atom->string() == QLatin1String("classhierarchy")) { generateClassHierarchy(relative, m_qdb->getCppClasses()); } else if (atom->string() == QLatin1String("obsoleteclasses")) { |