Changeset 82127 in vbox

Timestamp:

Nov 23, 2019 8:45:29 AM (5 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

134937

Message:

DevVGA: Doxygen fixes. bugref:9218

File:

• trunk/src/VBox/Devices/Graphics/DevVGA-SVGA.cpp (modified) (4 diffs)

trunk/src/VBox/Devices/Graphics/DevVGA-SVGA.cpp

@@ -3380 +3380 @@
 
 
+/*
+ * These two macros are put outside vmsvgaR3FifoLoop because doxygen gets confused,
+ * even the latest version, and thinks we're documenting vmsvgaR3FifoLoop. Sigh.
+ */
+/** @def VMSVGAFIFO_GET_CMD_BUFFER_BREAK
+ * Macro for shortening calls to vmsvgaR3FifoGetCmdPayload.
+ *
+ * Will break out of the switch on failure.
+ * Will restart and quit the loop if the thread was requested to stop.
+ *
+ * @param   a_PtrVar        Request variable pointer.
+ * @param   a_Type          Request typedef (not pointer) for casting.
+ * @param   a_cbPayloadReq  How much payload to fetch.
+ * @remarks Accesses a bunch of variables in the current scope!
+ */
+# define VMSVGAFIFO_GET_CMD_BUFFER_BREAK(a_PtrVar, a_Type, a_cbPayloadReq) \
+            if (1) { \
+                (a_PtrVar) = (a_Type *)vmsvgaR3FifoGetCmdPayload((a_cbPayloadReq), pFIFO, offCurrentCmd, offFifoMin, offFifoMax, \
+                                                                 pbBounceBuf, &cbPayload, pThread, pThis, pSVGAState, pDevIns); \
+                if (RT_UNLIKELY((uintptr_t)(a_PtrVar) < 2)) { if ((uintptr_t)(a_PtrVar) == 1) continue; break; } \
+                RT_UNTRUSTED_NONVOLATILE_COPY_FENCE(); \
+            } else do {} while (0)
+/* @def VMSVGAFIFO_GET_MORE_CMD_BUFFER_BREAK
+ * Macro for shortening calls to vmsvgaR3FifoGetCmdPayload for refetching the
+ * buffer after figuring out the actual command size.
+ *
+ * Will break out of the switch on failure.
+ *
+ * @param   a_PtrVar        Request variable pointer.
+ * @param   a_Type          Request typedef (not pointer) for casting.
+ * @param   a_cbPayloadReq  How much payload to fetch.
+ * @remarks Accesses a bunch of variables in the current scope!
+ */
+# define VMSVGAFIFO_GET_MORE_CMD_BUFFER_BREAK(a_PtrVar, a_Type, a_cbPayloadReq) \
+            if (1) { \
+                VMSVGAFIFO_GET_CMD_BUFFER_BREAK(a_PtrVar, a_Type, a_cbPayloadReq); \
+            } else do {} while (0)
+
 /**
  * @callback_method_impl{PFNPDMTHREADDEV, The async FIFO handling thread.}
@@ -3596 +3634 @@
         }
 
-/** @def VMSVGAFIFO_GET_CMD_BUFFER_BREAK
- * Macro for shortening calls to vmsvgaR3FifoGetCmdPayload.
- *
- * Will break out of the switch on failure.
- * Will restart and quit the loop if the thread was requested to stop.
- *
- * @param   a_PtrVar        Request variable pointer.
- * @param   a_Type          Request typedef (not pointer) for casting.
- * @param   a_cbPayloadReq  How much payload to fetch.
- * @remarks Accesses a bunch of variables in the current scope!
- */
-# define VMSVGAFIFO_GET_CMD_BUFFER_BREAK(a_PtrVar, a_Type, a_cbPayloadReq) \
-            if (1) { \
-                (a_PtrVar) = (a_Type *)vmsvgaR3FifoGetCmdPayload((a_cbPayloadReq), pFIFO, offCurrentCmd, offFifoMin, offFifoMax, \
-                                                                 pbBounceBuf, &cbPayload, pThread, pThis, pSVGAState, pDevIns); \
-                if (RT_UNLIKELY((uintptr_t)(a_PtrVar) < 2)) { if ((uintptr_t)(a_PtrVar) == 1) continue; break; } \
-                RT_UNTRUSTED_NONVOLATILE_COPY_FENCE(); \
-            } else do {} while (0)
-/** @def VMSVGAFIFO_GET_MORE_CMD_BUFFER_BREAK
- * Macro for shortening calls to vmsvgaR3FifoGetCmdPayload for refetching the
- * buffer after figuring out the actual command size.
- *
- * Will break out of the switch on failure.
- *
- * @param   a_PtrVar        Request variable pointer.
- * @param   a_Type          Request typedef (not pointer) for casting.
- * @param   a_cbPayloadReq  How much payload to fetch.
- * @remarks Accesses a bunch of variables in the current scope!
- */
-# define VMSVGAFIFO_GET_MORE_CMD_BUFFER_BREAK(a_PtrVar, a_Type, a_cbPayloadReq) \
-            if (1) { \
-                VMSVGAFIFO_GET_CMD_BUFFER_BREAK(a_PtrVar, a_Type, a_cbPayloadReq); \
-            } else do {} while (0)
-
         /*
          * Mark the FIFO as busy.
@@ -4330 +4334 @@
                     }
 
-/**
+/** @def VMSVGAFIFO_CHECK_3D_CMD_MIN_SIZE_BREAK
  * Check that the 3D command has at least a_cbMin of payload bytes after the
  * header.  Will break out of the switch if it doesn't.
@@ -4784 +4788 @@
     return VINF_SUCCESS;
 }
+
+#undef VMSVGAFIFO_CHECK_3D_CMD_MIN_SIZE_BREAK
+#undef VMSVGAFIFO_GET_MORE_CMD_BUFFER_BREAK
+#undef VMSVGAFIFO_GET_CMD_BUFFER_BREAK
 
 /**