summaryrefslogtreecommitdiff
path: root/source/ext_inst.h
diff options
context:
space:
mode:
authorLei Zhang <antiagainst@google.com>2015-11-16 10:48:43 -0500
committerLei Zhang <antiagainst@google.com>2015-11-16 17:25:43 -0500
commitaf9906e4e5c851b5bc25a2130ef3f1a7f4aab3fc (patch)
tree9446d1baa3202e6aceff90c696980fc1efddb51b /source/ext_inst.h
parent287cfc1dd7be98ab1f78bbfc82d4f12c1c844a39 (diff)
Use Google comment style and fix typos.
Diffstat (limited to 'source/ext_inst.h')
-rw-r--r--source/ext_inst.h30
1 files changed, 8 insertions, 22 deletions
diff --git a/source/ext_inst.h b/source/ext_inst.h
index ee7c800c..6121c42d 100644
--- a/source/ext_inst.h
+++ b/source/ext_inst.h
@@ -30,34 +30,20 @@
#include "libspirv/libspirv.h"
#include "table.h"
-/// @brief Get the type from the extended instruction library string
-///
-/// @param name of the library
-///
-/// @return type of the extended instruction library
+// Gets the type of the extended instruction set with the specified name.
spv_ext_inst_type_t spvExtInstImportTypeGet(const char* name);
-/// @brief Find the extented instruction with value in the table
-///
-/// @param table to lookup
-/// @param type of the extended instruction import
-/// @param name of the extended instruction to find
-/// @param pEntry return the extended instruction entry
-///
-/// @return result code
+// Finds the named extented instruction of the given type in the given extended
+// instruction table. On success, returns SPV_SUCCESS and writes a handle of
+// the instruction entry into *entry.
spv_result_t spvExtInstTableNameLookup(const spv_ext_inst_table table,
const spv_ext_inst_type_t type,
const char* name,
- spv_ext_inst_desc* pEntry);
+ spv_ext_inst_desc* entry);
-/// @brief Find the extented instruction with value in the table
-///
-/// @param table to lookup
-/// @param type of the extended instruction import
-/// @param value of the extended instruction to find
-/// @param pEntry return the extended instruction entry
-///
-/// @return result code
+// Finds the extented instruction of the given type in the given extended
+// instruction table by value. On success, returns SPV_SUCCESS and writes a
+// handle of the instruction entry into *entry.
spv_result_t spvExtInstTableValueLookup(const spv_ext_inst_table table,
const spv_ext_inst_type_t type,
const uint32_t value,