diff options
| author | Jan-Arve Saether <jan-arve.saether@nokia.com> | 2012-08-17 11:52:40 +0200 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-17 19:31:50 +0200 |
| commit | 526da72e991e11205436a6363b6cfb6948a0eb0c (patch) | |
| tree | 1fd22bbbeee38b4ea00ce0abf437b69385f4de9a /src/tools/qdoc/doc/qdoc-manual.qdoc | |
| parent | 8160ca6dfd5332993e22fc82597aac947f335ee6 (diff) | |
Fix a bug in qdocs handling of excludedirs
The bug was there because the way qdoc tries to exclude the directories
given in the "excludedirs" variable:
It did a simple string comparision on the candidate path (to include)
with every string in the "excludedirs" variable.
However, this did not work for all cases, since the paths are not
canonicalized.
For instance, the problem I faced was that the following qdocconf
fragment: (config file located in doc/qtwidgets.qdocconf)
sourcedirs += ..
excludedirs += snippets
Since qdoc would recursively parse all subfolders of sourcedirs, it
would at one point visit the snippets folder, but it would have the
relative path "../doc/snippets", which did not match with "snippets",
causing snippets to not be excluded.
In addition, it seems that qdoc tries hard not to use absolute paths
(maybe because of more human-friendly error messages). I therefore
chose to canonicalize the relative paths.
As a side-effect this also give a better output from qdoc, as
../doc/foo.qdoc:42: Missing link
will become
foo.qdoc:42: Missing link
Change-Id: If9c25fa569abd03542bd12675acd44d8f4e0282c
Reviewed-by: Martin Smith <martin.smith@nokia.com>
Diffstat (limited to 'src/tools/qdoc/doc/qdoc-manual.qdoc')
| -rw-r--r-- | src/tools/qdoc/doc/qdoc-manual.qdoc | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual.qdoc b/src/tools/qdoc/doc/qdoc-manual.qdoc index ecd3741a1f..c29d0c895d 100644 --- a/src/tools/qdoc/doc/qdoc-manual.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual.qdoc @@ -5634,7 +5634,7 @@ colons (\c{::}). \code - A link to the UI Component's TabWidget is \l {UIComponent::TabWidget}. + A link to the UI Component's TabWidget is \l {UIComponent::TabWidget}. \endcode QDoc will generate a page for the module with a listing of the members @@ -7599,14 +7599,11 @@ \l {sourcedirs-variable} {sourcedirs} or \l {headerdirs-variable} {headerdirs} variables. - For example in \l qt.qdocconf + For example, \code - excludedirs = $QTDIR/extensions/activeqt \ - $QTDIR/extensions/motif \ - $QTDIR/tools/designer/src/lib/extension \ - $QTDIR/tools/designer/src/lib/sdk \ - $QTDIR/tools/designer/src/lib/uilib + sourcedirs = src/corelib + excludedirs = src/corelib/tmp \endcode When executed, QDoc will exclude the listed directories from |