From 976bdd9854045a252d458cdc75076a0e51fc231f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mario=20H=C3=BCttel?= <mario.huettel@gmx.net>
Date: Tue, 5 Mar 2019 20:21:49 +0100
Subject: [PATCH] Fix function description

---
 gds-parser/gds-tree-checker.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/gds-parser/gds-tree-checker.h b/gds-parser/gds-tree-checker.h
index 964b1b9..199ace5 100644
--- a/gds-parser/gds-tree-checker.h
+++ b/gds-parser/gds-tree-checker.h
@@ -35,6 +35,12 @@
 
 /**
  * @brief gds_tree_check_cell_references checks if all child cell references can be resolved in the given library
+ *
+ * This function will only mark cells that
+ * directly contain unresolved references.
+ *
+ * If a cell contains a reference to a cell with unresolved references, it is not flagged.
+ *
  * @param lib The GDS library to check
  * @return less than 0 if an error occured during processing; 0 if all child cells could be resolved;
  *         greater than zero if the processing was successful but not all cell references could be resolved.