SF.net SVN: geany:[3152] trunk/src/filetypes.c

[eht16 at users.sourceforge.net]

Revision: 3152
          http://geany.svn.sourceforge.net/geany/?rev=3152&view=rev
Author:   eht16
Date:     2008-10-25 18:56:12 +0000 (Sat, 25 Oct 2008)

Log Message:
-----------
Fix doc comment.

Modified Paths:
--------------
    trunk/src/filetypes.c

Modified: trunk/src/filetypes.c
===================================================================
--- trunk/src/filetypes.c	2008-10-25 18:56:04 UTC (rev 3151)
+++ trunk/src/filetypes.c	2008-10-25 18:56:12 UTC (rev 3152)
@@ -804,7 +804,14 @@
 
 #ifdef HAVE_PLUGINS
 /* Currently only used by external plugins (e.g. geanyprj). */
-/** Detect filetype based on a shebang line in the file, or the filename extension. */
+/**
+ *  Detect filetype based on a shebang line in the file, or the filename extension.
+ *
+ *  @param utf8_filename The filename in UTF-8 encoding.
+ *
+ *  @return The detected filetype for @c utf8_filename or @c filetypes[GEANY_FILETYPES_NONE]
+ *          if it could not be detected.
+ **/
 GeanyFiletype *filetypes_detect_from_file(const gchar *utf8_filename)
 {
 	gchar line[1024];


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