Hi Jacob, On Fri, Aug 05, 2022 at 01:35:45AM +0200, Jan Engelhardt wrote: > > >+ * mnl_attr_get_s8 - returns 8-bit signed integer attribute payload > >+ * > >+ * This function returns the 8-bit value of the attribute payload. > >+ */ > > That's kinda redundant - it's logically the same thing, just written > ever-so-slightly differently. > > > >+/** > >+ * mnl_attr_get_s64 - returns 64-bit signed integer attribute. > > This > >+ * function is align-safe, since accessing 64-bit Netlink attributes is a > >+ * common source of alignment issues. > > That sentence is self-defeating. If NLA access is a commn source of > alignment issues, then, by transitivity, this function too would > be potentially affected. Just > > "This function reads the 64-bit nlattr in an alignment-safe manner." > > Please use the following documentation style for *all* new functions. The man pages look better that way: > * mnl_attr_get_s8 - get 8-bit signed integer attribute payload > * \param attr pointer to netlink attribute > * > * \return 8-bit value of the attribute payload I.e. "get" instead of "returns" in 1-line description; Use \return instead of "This function returns the"; No full stop at end of \return description. Cheers ... Duncan.
