Add more comments

sherpa-onnx/csrc/utils.h

@@ -11,6 +11,20 @@
 
 namespace sherpa_onnx {
 
+/* Encode the hotwords in a input stream to be tokens ids.
+ *
+ * @param is The input stream, it contains several lines, one hotwords for each
+ *           line. For each hotword, the tokens (cjkchar or bpe) are separated
+ *           by spaces.
+ * @symbol_table  The tokens table mapping symbols to ids. All the symbols in
+ *                the stream should be in the symbol_table, if not this function
+ *                returns fasle.
+ *
+ * @hotwords  The encoded ids to be written to.
+ *
+ * @return  If all the symbols from ``is`` are in the symbol_table, returns true
+ *          otherwise returns false.
+ */
 bool EncodeHotwords(std::istream &is, const SymbolTable &symbol_table,
                     std::vector<std::vector<int32_t>> *hotwords);