summaryrefslogtreecommitdiffstats
path: root/tools/qdoc3/config.cpp
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2009-12-04 14:01:49 (GMT)
committerMartin Smith <msmith@trolltech.com>2009-12-04 14:01:49 (GMT)
commit77f274672480e5980d9f42e4fd94c9770279543b (patch)
tree159b4e4238d8e9ec6d5c056db4c8090a164850cb /tools/qdoc3/config.cpp
parent271936b063fb261293e3f77f7a2273e3a4dbb5d6 (diff)
downloadQt-77f274672480e5980d9f42e4fd94c9770279543b.zip
Qt-77f274672480e5980d9f42e4fd94c9770279543b.tar.gz
Qt-77f274672480e5980d9f42e4fd94c9770279543b.tar.bz2
doc: Example page now lists images used by the example
It just links to an empty page at the moment, i.e., it doesn't load the images. But I will add that. Task-number: QTBUG-4484
Diffstat (limited to 'tools/qdoc3/config.cpp')
-rw-r--r--tools/qdoc3/config.cpp12
1 files changed, 12 insertions, 0 deletions
diff --git a/tools/qdoc3/config.cpp b/tools/qdoc3/config.cpp
index 0fc3606..1a4e46e 100644
--- a/tools/qdoc3/config.cpp
+++ b/tools/qdoc3/config.cpp
@@ -399,6 +399,13 @@ QStringList Config::getAllFiles(const QString &filesVar,
}
/*!
+ \a fileName is the path of the file to find.
+
+ \a files and \a dirs are the lists where we must find the
+ components of \a fileName.
+
+ \a location is used for obtaining the file and line numbers
+ for report qdoc errors.
*/
QString Config::findFile(const Location& location,
const QStringList& files,
@@ -527,6 +534,11 @@ QString Config::findFile(const Location& location,
}
/*!
+ Copies the \a sourceFilePath to the file name constructed by
+ concatenating \a targetDirPath and \a userFriendlySourceFilePath.
+ \a location is for identifying the file and line number where
+ a qdoc error occurred. The constructed output file name is
+ returned.
*/
QString Config::copyFile(const Location& location,
const QString& sourceFilePath,