Whitespace

This commit is contained in:
Paul Ferrand 2020-01-04 16:32:35 +01:00
parent 5a21c52164
commit 67fdd6766f

View file

@ -145,10 +145,10 @@ absl::optional<uint8_t> readNoteValue(const absl::string_view& value);
* return them, while updating the source by removing this header * return them, while updating the source by removing this header
* and members from the beginning. The function "consumes" the * and members from the beginning. The function "consumes" the
* header and its members from the source if found. * header and its members from the source if found.
* *
* No check is made to see if the header is "valid" in the sfz sense. * No check is made to see if the header is "valid" in the sfz sense.
* The output parameters are set only if the method returns true. * The output parameters are set only if the method returns true.
* *
* @param source A source view; can be updated and shortened * @param source A source view; can be updated and shortened
* @param header An output view on the header, without the <> * @param header An output view on the header, without the <>
* @param members An output view on the members, untrimmed * @param members An output view on the members, untrimmed
@ -161,44 +161,44 @@ bool findHeader(absl::string_view& source, absl::string_view& header, absl::stri
* Return them while updating the source by removing this opcode * Return them while updating the source by removing this opcode
* and value from the beginning. The function "consumes" the * and value from the beginning. The function "consumes" the
* opcode from the source if one is found. * opcode from the source if one is found.
* *
* No check is made to see if the opcode is "valid" in the sfz sense. * No check is made to see if the opcode is "valid" in the sfz sense.
* The output parameters are set only if the method returns true. * The output parameters are set only if the method returns true.
* *
* @param source A source view; can be updated and shortened * @param source A source view; can be updated and shortened
* @param opcode An output view on the opcode name * @param opcode An output view on the opcode name
* @param value An output view on the opcode value * @param value An output view on the opcode value
* @return true if an opcode was found * @return true if an opcode was found
* @return false * @return false
*/ */
bool findOpcode(absl::string_view& source, absl::string_view& opcode, absl::string_view& value); bool findOpcode(absl::string_view& source, absl::string_view& opcode, absl::string_view& value);
/** /**
* @brief Find an SFZ #define statement on a line and return the variable and value as views. * @brief Find an SFZ #define statement on a line and return the variable and value as views.
* *
* This function assums that there is a single define per line and that the variable and value * This function assums that there is a single define per line and that the variable and value
* are separated by whitespace. * are separated by whitespace.
* The output parameters are set only if the method returns true. * The output parameters are set only if the method returns true.
* *
* @param line The source line * @param line The source line
* @param variable An output view on the define variable * @param variable An output view on the define variable
* @param value An output view on the define value * @param value An output view on the define value
* @return true If a define was found * @return true If a define was found
* @return false * @return false
*/ */
bool findDefine(absl::string_view line, absl::string_view& variable, absl::string_view& value); bool findDefine(absl::string_view line, absl::string_view& variable, absl::string_view& value);
/** /**
* @brief Find an SFZ #include statement on a line and return included path. * @brief Find an SFZ #include statement on a line and return included path.
* *
* This function assums that there is a single include per line and that the * This function assums that there is a single include per line and that the
* include path is within quotes. * include path is within quotes.
* The output parameter is set only if the method returns true. * The output parameter is set only if the method returns true.
* *
* @param line The source line * @param line The source line
* @param path The path, if found * @param path The path, if found
* @return true If an include was found * @return true If an include was found
* @return false * @return false
*/ */
bool findInclude(absl::string_view line, std::string& path); bool findInclude(absl::string_view line, std::string& path);