From 5ed34884931ae0d6a5be01f87d6d4049ae0dd1cb Mon Sep 17 00:00:00 2001 From: manuelk Date: Fri, 17 May 2013 14:07:53 -0700 Subject: [PATCH] more doxy / comment fixes --- opensubdiv/far/kernelBatch.h | 2 ++ opensubdiv/far/patchTables.h | 3 +++ opensubdiv/osd/clComputeContext.h | 6 ++++-- opensubdiv/osd/cpuComputeContext.h | 4 ++-- opensubdiv/osd/cudaComputeContext.h | 4 ++-- opensubdiv/osd/glDrawContext.h | 2 +- opensubdiv/osd/glslComputeContext.h | 4 ++-- opensubdiv/osd/glslTransformFeedbackComputeContext.h | 4 ++-- 8 files changed, 18 insertions(+), 11 deletions(-) diff --git a/opensubdiv/far/kernelBatch.h b/opensubdiv/far/kernelBatch.h index ed3d6dce..1f8860ab 100644 --- a/opensubdiv/far/kernelBatch.h +++ b/opensubdiv/far/kernelBatch.h @@ -128,6 +128,8 @@ public: /// /// @param vertexOffset XXXX /// + /// @param meshIndex XXXX + /// FarKernelBatch( KernelType kernelType, int level, int tableIndex, diff --git a/opensubdiv/far/patchTables.h b/opensubdiv/far/patchTables.h index cd9d8c76..d27a2a92 100644 --- a/opensubdiv/far/patchTables.h +++ b/opensubdiv/far/patchTables.h @@ -253,6 +253,9 @@ public: public: /// Constructor. /// + /// @param desc descriptor information for the patches in + /// the array + /// /// @param vertIndex absolute index to the first control vertex /// of the first patch in the PTable /// diff --git a/opensubdiv/osd/clComputeContext.h b/opensubdiv/osd/clComputeContext.h index b2b8da6f..f538b09a 100644 --- a/opensubdiv/osd/clComputeContext.h +++ b/opensubdiv/osd/clComputeContext.h @@ -146,9 +146,11 @@ public: /// that data buffers are properly inter-operated between Contexts and /// Controllers operating across multiple devices. /// - /// @param a buffer containing vertex-interpolated primvar data + /// @param vertex a buffer containing vertex-interpolated primvar data /// - /// @param a buffer containing varying-interpolated primvar data + /// @param varying a buffer containing varying-interpolated primvar data + /// + /// @param clQueue OpenCL command queue associated with the primvar data /// template void Bind(VERTEX_BUFFER *vertex, VARYING_BUFFER *varying, cl_command_queue clQueue) { diff --git a/opensubdiv/osd/cpuComputeContext.h b/opensubdiv/osd/cpuComputeContext.h index 3a53f8ce..72e5f5fd 100644 --- a/opensubdiv/osd/cpuComputeContext.h +++ b/opensubdiv/osd/cpuComputeContext.h @@ -140,9 +140,9 @@ public: /// that data buffers are properly inter-operated between Contexts and /// Controllers operating across multiple devices. /// - /// @param a buffer containing vertex-interpolated primvar data + /// @param vertex a buffer containing vertex-interpolated primvar data /// - /// @param a buffer containing varying-interpolated primvar data + /// @param varying a buffer containing varying-interpolated primvar data /// template void Bind(VERTEX_BUFFER *vertex, VARYING_BUFFER *varying) { diff --git a/opensubdiv/osd/cudaComputeContext.h b/opensubdiv/osd/cudaComputeContext.h index 1be66563..d1dce5cf 100644 --- a/opensubdiv/osd/cudaComputeContext.h +++ b/opensubdiv/osd/cudaComputeContext.h @@ -138,9 +138,9 @@ public: /// that data buffers are properly inter-operated between Contexts and /// Controllers operating across multiple devices. /// - /// @param a buffer containing vertex-interpolated primvar data + /// @param vertex a buffer containing vertex-interpolated primvar data /// - /// @param a buffer containing varying-interpolated primvar data + /// @param varying a buffer containing varying-interpolated primvar data /// template void Bind(VERTEX_BUFFER *vertex, VARYING_BUFFER *varying) { diff --git a/opensubdiv/osd/glDrawContext.h b/opensubdiv/osd/glDrawContext.h index 48a0581a..6a0fb3f3 100644 --- a/opensubdiv/osd/glDrawContext.h +++ b/opensubdiv/osd/glDrawContext.h @@ -101,7 +101,7 @@ public: virtual ~OsdGLDrawContext(); - /// \brienf Create an OsdGLDraContext from FarPatchTables + /// \brief Create an OsdGLDraContext from FarPatchTables /// /// @param patchTables a valid set of FarPatchTables /// diff --git a/opensubdiv/osd/glslComputeContext.h b/opensubdiv/osd/glslComputeContext.h index d8b32727..eaf3286b 100644 --- a/opensubdiv/osd/glslComputeContext.h +++ b/opensubdiv/osd/glslComputeContext.h @@ -158,9 +158,9 @@ public: /// that data buffers are properly inter-operated between Contexts and /// Controllers operating across multiple devices. /// - /// @param a buffer containing vertex-interpolated primvar data + /// @param vertex a buffer containing vertex-interpolated primvar data /// - /// @param a buffer containing varying-interpolated primvar data + /// @param varying a buffer containing varying-interpolated primvar data /// template void Bind(VERTEX_BUFFER *vertex, VARYING_BUFFER *varying) { diff --git a/opensubdiv/osd/glslTransformFeedbackComputeContext.h b/opensubdiv/osd/glslTransformFeedbackComputeContext.h index 600cc866..36af7788 100644 --- a/opensubdiv/osd/glslTransformFeedbackComputeContext.h +++ b/opensubdiv/osd/glslTransformFeedbackComputeContext.h @@ -155,9 +155,9 @@ public: /// that data buffers are properly inter-operated between Contexts and /// Controllers operating across multiple devices. /// - /// @param a buffer containing vertex-interpolated primvar data + /// @param vertex a buffer containing vertex-interpolated primvar data /// - /// @param a buffer containing varying-interpolated primvar data + /// @param varying a buffer containing varying-interpolated primvar data /// template void Bind(VERTEX_BUFFER *vertex, VARYING_BUFFER *varying) {