SF.net SVN: geany: [2647] trunk/src/document.h

[ntrel at users.sourceforge.net]

Revision: 2647
          http://geany.svn.sourceforge.net/geany/?rev=2647&view=rev
Author:   ntrel
Date:     2008-06-05 09:07:39 -0700 (Thu, 05 Jun 2008)

Log Message:
-----------
Update documentation for real_path, minor edit of file_name.

Modified Paths:
--------------
    trunk/src/document.h

Modified: trunk/src/document.h
===================================================================
--- trunk/src/document.h	2008-06-05 14:05:55 UTC (rev 2646)
+++ trunk/src/document.h	2008-06-05 16:07:39 UTC (rev 2647)
@@ -70,10 +70,10 @@
 	gboolean		 is_valid;
 	/** Whether this %document support source code symbols(tags) to show in the sidebar. */
 	gboolean		 has_tags;
-	/** The UTF-8 encoded file name. Be careful glibc and GLib functions expect the locale
-	 * representation of the file name which can be different from this.
-	 * For conversion into locale encoding for use with file functions of GLib, you can use
-	 * @ref utils_get_locale_from_utf8.
+	/** The UTF-8 encoded file name.
+	 * Be careful; glibc and GLib file functions expect the locale representation of the
+	 * file name which can be different from this.
+	 * For conversion into locale encoding, you can use @ref utils_get_locale_from_utf8().
 	 * @see real_path. */
 	gchar 			*file_name;
 	/** The encoding of the %document, must be a valid string representation of an encoding, can
@@ -109,7 +109,9 @@
 	 * If non-NULL, this indicates the file once existed on disk (not just as an
 	 * unsaved document with a filename set).
 	 *
-	 * @note This is the same as: @c tm_get_real_path(doc->file_name); */
+	 * @note This is only assigned after a successful save or open - it should
+	 * not be set elsewhere.
+	 * @see file_name. */
 	gchar 			*real_path;
 }
 GeanyDocument;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.