Fix many typos.

diff --git a/include/libspirv/libspirv.h b/include/libspirv/libspirv.h
index 1f9d68a..da62e32 100644 (file)
--- a/include/libspirv/libspirv.h
+++ b/include/libspirv/libspirv.h
@@ -90,7 +90,7 @@ typedef enum spv_endianness_t {
 // The assembler uses all operand types.  In addition to determining what
 // kind of value an operand may be, non-concrete operand types capture the
 // fact that an operand might be optional (may be absent, or present exactly
-// once), or might occure zero or more times.
+// once), or might occur zero or more times.
 //
 // Sometimes we also need to be able to express the fact that an operand
 // is a member of an optional tuple of values.  In that case the first member
@@ -330,7 +330,7 @@ typedef struct spv_diagnostic_t {
 } spv_diagnostic_t;
 
 // Opaque struct containing the context used to operate on a SPIR-V module.
-// Its object is used by various tranformation API functions.
+// Its object is used by various translation API functions.
 struct spv_context_t;
 
 // Type Definitions
@@ -358,7 +358,7 @@ spv_result_t spvTextToBinary(const spv_const_context context, const char* text,
                              const size_t length, spv_binary* binary,
                              spv_diagnostic* diagnostic);
 
-// @brief Frees an allocated text stream. This is a no-op if the text parameter
+// Frees an allocated text stream. This is a no-op if the text parameter
 // is a null pointer.
 void spvTextDestroy(spv_text text);
 

diff --git a/source/assembly_grammar.h b/source/assembly_grammar.h
index 4aabfe0..f92bf97 100644 (file)
--- a/source/assembly_grammar.h
+++ b/source/assembly_grammar.h
@@ -84,7 +84,7 @@ class AssemblyGrammar {
   // where each term is a named enum value for a given type. No whitespace
   // is permitted.
   //
-  // On success, the value is written to pValue, and SPV_SUCCESS is returend.
+  // On success, the value is written to pValue, and SPV_SUCCESS is returned.
   // The operand type is defined by the type parameter, and the text to be
   // parsed is defined by the textValue parameter.
   spv_result_t parseMaskOperand(const spv_operand_type_t type,
@@ -106,8 +106,8 @@ class AssemblyGrammar {
   // of the given pattern.
   //
   // Each set bit in the mask represents zero or more operand types that should
-  // be prepended onto the pattern. Opearnds for a less significant bit always
-  // appear before operands for a more significatn bit.
+  // be prepended onto the pattern. Operands for a less significant bit always
+  // appear before operands for a more significant bit.
   //
   // If a set bit is unknown, then we assume it has no operands.
   void prependOperandTypesForMask(const spv_operand_type_t type,

diff --git a/source/table.h b/source/table.h
index e6559af..3870d5b 100644 (file)
--- a/source/table.h
+++ b/source/table.h
@@ -103,25 +103,13 @@ struct spv_context_t {
   const spv_ext_inst_table ext_inst_table;
 };
 
-/// @brief Populate the Opcode table
-///
-/// @param[out] pOpcodeTable table to be populated
-///
-/// @return result code
+// Populates the given opcode table.
 spv_result_t spvOpcodeTableGet(spv_opcode_table* pOpcodeTable);
 
-/// @brief Populate the operand table
-///
-/// @param[in] pOperandTable table to be populated
-///
-/// @return result code
+// Populates the given operand table.
 spv_result_t spvOperandTableGet(spv_operand_table* pOperandTable);
 
-/// @brief Populate the extended instruction table
-///
-/// @param pTable table to be populated
-///
-/// @return result code
+// Populates the given extended instruction table.
 spv_result_t spvExtInstTableGet(spv_ext_inst_table* pTable);
 
 #endif  // LIBSPIRV_TABLE_H_

diff --git a/source/text_handler.h b/source/text_handler.h
index 699d550..1211eb4 100644 (file)
--- a/source/text_handler.h
+++ b/source/text_handler.h
@@ -151,7 +151,7 @@ class AssemblyContext {
 
   // Returns the next word in the input stream. It is invalid to call this
   // method if position has been set to a location in the stream that does not
-  // exist. If there are no subsequent words, the empty string will be returend.
+  // exist. If there are no subsequent words, the empty string will be returned.
   std::string getWord() const;
 
   // Returns true if the next word in the input is the start of a new Opcode.
@@ -174,7 +174,7 @@ class AssemblyContext {
     return diagnostic(SPV_ERROR_INVALID_TEXT);
   }
 
-  // Returns then next characted in the input stream.
+  // Returns then next character in the input stream.
   char peek() const;
 
   // Returns true if there is more text in the input stream.
@@ -207,7 +207,7 @@ class AssemblyContext {
   // 32-bit integer.
   // Returns SPV_SUCCESS if the value could be correctly added to the
   // instruction.  Returns the given error code on failure, and emits
-  // a diagnotic if that error code is not SPV_FAILED_MATCH.
+  // a diagnostic if that error code is not SPV_FAILED_MATCH.
   spv_result_t binaryEncodeNumericLiteral(const char* numeric_literal,
                                           spv_result_t error_code,
                                           const IdType& type,