Add documentation of parameters of new function.

doxygen · Jan 1, 2021 · f80b038 · f80b038
1 parent a61f19c
commit f80b038
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/dotdirdeps.cpp b/src/dotdirdeps.cpp
@@ -23,9 +23,9 @@
 /**
  * Puts DOT code for drawing directory to stream and adds it to the list.
  * @param outStream[in,out] stream to which the DOT code is written to
- * @param directory
- * @param fillBackground
- * @param directoriesInGraph[in,out]
+ * @param directory[in] will be mapped to a node in DOT code
+ * @param fillBackground[in] if the node shall be explicitly filled
+ * @param directoriesInGraph[in,out] lists the directories which have been written to the output stream
  */
 static void drawDirectory(FTextStream &outStream, const DirDef *const directory, const bool fillBackground,
     QDict<DirDef> &directoriesInGraph)