summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Lioncash2019-05-09 19:02:52 -0400
committerGravatar Lioncash2019-05-09 19:09:19 -0400
commit53afe47cec0bfb7ae8b78a95d15f0e081e1a84c9 (patch)
tree13302fe51290eb4efd7bd1e0d88f635f708e139f
parentvideo_core/memory_manager: Remove superfluous const from function declarations (diff)
downloadyuzu-53afe47cec0bfb7ae8b78a95d15f0e081e1a84c9.tar.gz
yuzu-53afe47cec0bfb7ae8b78a95d15f0e081e1a84c9.tar.xz
yuzu-53afe47cec0bfb7ae8b78a95d15f0e081e1a84c9.zip
video_core/memory_manager: Amend doxygen comments
Corrects references to non-existent parameters and corrects typos.
-rw-r--r--src/video_core/memory_manager.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/video_core/memory_manager.h b/src/video_core/memory_manager.h
index b9a683497..ade18c139 100644
--- a/src/video_core/memory_manager.h
+++ b/src/video_core/memory_manager.h
@@ -65,12 +65,12 @@ public:
65 u8* GetPointer(GPUVAddr addr); 65 u8* GetPointer(GPUVAddr addr);
66 const u8* GetPointer(GPUVAddr addr) const; 66 const u8* GetPointer(GPUVAddr addr) const;
67 67
68 // Returns true if the block is continous in host memory, false otherwise 68 // Returns true if the block is continuous in host memory, false otherwise
69 bool IsBlockContinous(GPUVAddr start, std::size_t size); 69 bool IsBlockContinous(GPUVAddr start, std::size_t size);
70 70
71 /** 71 /**
72 * ReadBlock and WriteBlock are full read and write operations over virtual 72 * ReadBlock and WriteBlock are full read and write operations over virtual
73 * GPU Memory. It's important to use these when GPU memory may not be continous 73 * GPU Memory. It's important to use these when GPU memory may not be continuous
74 * in the Host Memory counterpart. Note: This functions cause Host GPU Memory 74 * in the Host Memory counterpart. Note: This functions cause Host GPU Memory
75 * Flushes and Invalidations, respectively to each operation. 75 * Flushes and Invalidations, respectively to each operation.
76 */ 76 */
@@ -111,10 +111,10 @@ private:
111 /** 111 /**
112 * Maps an unmanaged host memory pointer at a given address. 112 * Maps an unmanaged host memory pointer at a given address.
113 * 113 *
114 * @param target The guest address to start the mapping at. 114 * @param target The guest address to start the mapping at.
115 * @param memory The memory to be mapped. 115 * @param memory The memory to be mapped.
116 * @param size Size of the mapping. 116 * @param size Size of the mapping in bytes.
117 * @param state MemoryState tag to attach to the VMA. 117 * @param backing_addr The base address of the range to back this mapping.
118 */ 118 */
119 VMAHandle MapBackingMemory(GPUVAddr target, u8* memory, u64 size, VAddr backing_addr); 119 VMAHandle MapBackingMemory(GPUVAddr target, u8* memory, u64 size, VAddr backing_addr);
120 120
@@ -124,7 +124,7 @@ private:
124 /// Converts a VMAHandle to a mutable VMAIter. 124 /// Converts a VMAHandle to a mutable VMAIter.
125 VMAIter StripIterConstness(const VMAHandle& iter); 125 VMAIter StripIterConstness(const VMAHandle& iter);
126 126
127 /// Marks as the specfied VMA as allocated. 127 /// Marks as the specified VMA as allocated.
128 VMAIter Allocate(VMAIter vma); 128 VMAIter Allocate(VMAIter vma);
129 129
130 /** 130 /**