NFD » ndn-cxx

Block class has a remove method:

void
remove(uint32_t type);

This method is missing Doxygen, is missing a test case, and is unused within ndn-cxx.

Based on function name and signature, either of the following semantics are reasonable:

/** \brief remove all subelements of \p type
 *  \param type TLV-TYPE of subelement to remove
 *  \pre parse() has been invoked
 */

/** \brief remove the first subelements of \p type
 *  \param type TLV-TYPE of subelement to remove
 *  \pre parse() has been invoked
 */

However, the actual behavior is: remove all subelements whose TLV-TYPE is not type.

This semantics is surprising.

To solve this bug:

1. decide on the correct semantics
2. add Doxygen
3. add test case
4. fix implementation
5. post a "potential breaking change" notice to ndn-lib mailing list
6. fix regressions on dependent projects, if any