tools/qdoc3/config.cpp
changeset 3 41300fa6a67c
parent 0 1918ee327afb
child 4 3b1da2848fc7
--- a/tools/qdoc3/config.cpp	Tue Jan 26 12:42:25 2010 +0200
+++ b/tools/qdoc3/config.cpp	Tue Feb 02 00:43:10 2010 +0200
@@ -399,6 +399,13 @@
 }
 
 /*!
+  \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 @@
 }
 
 /*!
+  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,