GUI: Add comment about storing paths.

2011-01-06 20:45:07 +02:00 · 2011-01-06 20:45:07 +02:00 · 6e0f6c5aec
parent 2a93aa9fce
commit 6e0f6c5aec
1 changed files with 5 additions and 0 deletions
--- a/gui/erroritem.h
+++ b/gui/erroritem.h
@ -30,6 +30,11 @@ class ErrorLine;

 /**
 * @brief A class containing error data for one error.
+* 
+* The paths are stored with internal ("/") separators. Only when we show the
+* path or copy if for user (to clipboard) we convert to native separators.
+* Full path is stored instead of relative path for flexibility. It is easy
+* to get the relative path from full path when needed.
 */
 class ErrorItem
 {