Skip to content

Commit

Permalink
docs: add Doxygen comments for newly added BNK functions
Browse files Browse the repository at this point in the history
  • Loading branch information
abheekda1 committed May 31, 2022
1 parent e3de6a1 commit 2ede781
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions include/wwtools/bnk.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,23 @@ void extract(const std::string &indata, std::vector<std::string> &outdata);
*/
std::string get_info(const std::string &indata);

/**
* @brief get WEMs correlating to a BNK and an optional event ID
*
* @param indata std::string with the file data
* @param in_event_id the input event ID
* @return a printable info string
*/
std::string get_event_id_info(const std::string &indata,
const std::string &in_event_id);

/**
* @brief get the ID of a WEM at an index
*
* @param indata std::string with the file data
* @param index the index to get the ID from
* @return the ID as a string
*/
std::string get_wem_id_at_index(const std::string &indata, const int &index);

std::string get_event_action_type(bnk_t::action_type_t action_type);
Expand Down

0 comments on commit 2ede781

Please sign in to comment.