[Scummvm-cvs-logs] SF.net SVN: scummvm:[46141] scummvm/trunk/sound/fmopl.h

[lordhoto at users.sourceforge.net]

Revision: 46141
          http://scummvm.svn.sourceforge.net/scummvm/?rev=46141&view=rev
Author:   lordhoto
Date:     2009-11-25 23:17:16 +0000 (Wed, 25 Nov 2009)

Log Message:
-----------
Extend documentation slightly.

Modified Paths:
--------------
    scummvm/trunk/sound/fmopl.h

Modified: scummvm/trunk/sound/fmopl.h
===================================================================
--- scummvm/trunk/sound/fmopl.h	2009-11-25 23:02:03 UTC (rev 46140)
+++ scummvm/trunk/sound/fmopl.h	2009-11-25 23:17:16 UTC (rev 46141)
@@ -71,6 +71,8 @@
 
 	/**
 	 * Detects a driver for the specific type.
+	 *
+	 * @return Returns a valid driver id on success, -1 otherwise.
 	 */
 	static DriverId detect(OplType type);
 


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