[Scummvm-cvs-logs] SF.net SVN: scummvm:[40303] scummvm/trunk/engines/sci/engine/vm.h

fingolfin at users.sourceforge.net fingolfin at users.sourceforge.net
Mon May 4 17:04:26 CEST 2009


Revision: 40303
          http://scummvm.svn.sourceforge.net/scummvm/?rev=40303&view=rev
Author:   fingolfin
Date:     2009-05-04 15:04:26 +0000 (Mon, 04 May 2009)

Log Message:
-----------
SCI: Added doxygen comment to MemObject::MemObject

Modified Paths:
--------------
    scummvm/trunk/engines/sci/engine/vm.h

Modified: scummvm/trunk/engines/sci/engine/vm.h
===================================================================
--- scummvm/trunk/engines/sci/engine/vm.h	2009-05-04 14:20:17 UTC (rev 40302)
+++ scummvm/trunk/engines/sci/engine/vm.h	2009-05-04 15:04:26 UTC (rev 40303)
@@ -56,14 +56,21 @@
 	int _segmgrId; /**< Internal value used by the seg_manager's hash map */
 
 public:
+	static MemObject *createMemObject(MemObjectType type);
+
+public:
 	virtual ~MemObject() {}
 
+	/**
+	 * Dereferences a raw memory pointer.
+	 * @param reg   reference to dereference
+	 * @param size  if not NULL, set to the theoretical maximum size of the referenced data block
+	 * @return              the data block referenced
+	 */
 	virtual byte *dereference(reg_t pointer, int *size);
 
 	inline MemObjectType getType() const { return _type; }
 	inline int getSegMgrId() const { return _segmgrId; }
-
-	static MemObject *createMemObject(MemObjectType type);
 };
 
 


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




More information about the Scummvm-git-logs mailing list