aboutsummaryrefslogtreecommitdiff
path: root/engines
diff options
context:
space:
mode:
authorMax Horn2009-05-19 11:22:06 +0000
committerMax Horn2009-05-19 11:22:06 +0000
commit613ca85bf9577b8f145e6daece1c739da8d2d759 (patch)
tree6b3ab54f3c9f718e5d32830c345eff39fdcb5511 /engines
parentdf3357159c2262ddeb70bea241364df5bf929418 (diff)
downloadscummvm-rg350-613ca85bf9577b8f145e6daece1c739da8d2d759.tar.gz
scummvm-rg350-613ca85bf9577b8f145e6daece1c739da8d2d759.tar.bz2
scummvm-rg350-613ca85bf9577b8f145e6daece1c739da8d2d759.zip
SCI: Doxygenified a few comments
svn-id: r40720
Diffstat (limited to 'engines')
-rw-r--r--engines/sci/engine/vm.h45
1 files changed, 27 insertions, 18 deletions
diff --git a/engines/sci/engine/vm.h b/engines/sci/engine/vm.h
index c187179bb8..e9737195a1 100644
--- a/engines/sci/engine/vm.h
+++ b/engines/sci/engine/vm.h
@@ -67,6 +67,9 @@ public:
public:
virtual ~MemObject() {}
+ inline MemObjectType getType() const { return _type; }
+ inline int getSegMgrId() const { return _segmgrId; }
+
/**
* Dereferences a raw memory pointer.
* @param reg reference to dereference
@@ -75,30 +78,36 @@ public:
*/
virtual byte *dereference(reg_t pointer, int *size);
- inline MemObjectType getType() const { return _type; }
- inline int getSegMgrId() const { return _segmgrId; }
-
- // Finds the canonic address associated with sub_reg
- // Parameters: (reg_t) sub_addr: The base address whose canonic address is to be found
- // For each valid address a, there exists a canonic address c(a) such that c(a) = c(c(a)).
- // This address "governs" a in the sense that deallocating c(a) will deallocate a.
+ /**
+ * Finds the canonic address associated with sub_reg.
+ *
+ * For each valid address a, there exists a canonic address c(a) such that c(a) = c(c(a)).
+ * This address "governs" a in the sense that deallocating c(a) will deallocate a.
+ *
+ * @param sub_addr base address whose canonic address is to be found
+ */
virtual reg_t findCanonicAddress(SegManager *segmgr, reg_t sub_addr) { return sub_addr; }
- // Deallocates all memory associated with the specified address
- // Parameters: (reg_t) sub_addr: The address (within the given segment) to deallocate
+ /**
+ * Deallocates all memory associated with the specified address.
+ * @param sub_addr address (within the given segment) to deallocate
+ */
virtual void freeAtAddress(SegManager *segmgr, reg_t sub_addr) {}
- // Iterates over and reports all addresses within the current segment
- // Parameters: note : (voidptr * addr) -> (): Invoked for each address on which free_at_address()
- // makes sense
- // (void *) param: Parameter passed to 'note'
+ /**
+ * Iterates over and reports all addresses within the current segment.
+ * @param note Invoked for each address on which free_at_address() makes sense
+ * @param param parameter passed to 'note'
+ */
virtual void listAllDeallocatable(SegmentId segId, void *param, NoteCallback note) {}
- // Iterates over all references reachable from the specified object
- // Parameters: (reg_t) object: The object (within the current segment) to analyse
- // (void *) param: Parameter passed to 'note'
- // note : (voidptr * addr) -> (): Invoked for each outgoing reference within the object
- // Note: This function may also choose to report numbers (segment 0) as adresses
+ /**
+ * Iterates over all references reachable from the specified object.
+ * @param object object (within the current segment) to analyse
+ * @param param parameter passed to 'note'
+ * @param note Invoked for each outgoing reference within the object
+ * Note: This function may also choose to report numbers (segment 0) as adresses
+ */
virtual void listAllOutgoingReferences(EngineState *s, reg_t object, void *param, NoteCallback note) {}
};