module api: fix formatting comments for Doxygen

- remove < and > around function names to make them resolvable
- place @sa and \sa to the new lines and remove round parenthesis around
- add missed dots
- added comments for box_tuple_upsert, box_tuple_update, luaT_pusherror
  etc.
- replace \example tags with \code and \endcode, because \example
  requires a file name with example, when \code allows to place a code
  inline
- comments for macros alignof and likely/unlikely looks a bit ugly,
  but I couldn't find a better way to resolve doxygen warning
- remove dashes after @param
- corrected comments for box_tuple_update() and box_tuple_upsert()

Closes #8194

NO_CHANGELOG=fix doxygen
NO_DOC=fix doxygen
NO_TEST=fix doxygen