- Could you (in the future) please use javadoc style for files in
the core, tm and files added by me? That means using /** shortdesc . ... instead of /*! \brief shortdesc */
In kamailio, we had /*!
The \brief needs to be there regardless, like \file and all the other doxygen commands.
I think we need *one* standard, regardless of where files are, having one for core, tm and Andrei-files does not make sense to me. I can settle with both /** and /*!, just got used to /*! from Kamailio and Asterisk.
Another rule is that contributors must obey the format of main developer. For example, I like opening brackets on a new line after if/while/etc. Others want it at the end of line. When adding code to parts not started by me I try to conform the general pattern found in the file. I expect same from the others.
In this case, it's requirements made by doxygen that forces us to use backslashes, regardless of what Andrei thinks ;-)
No, it's not. The nice thing about doxygen is that it accepts javadoc style (JAVADOC_AUTOBRIEF should be set to YES in the config) and qt style comments too. Almost all doxygen style tags (or at least the one that are mostly used) have equivalent javadoc tags, e.g.:
Instead of /*! \brief txt ... */ - /** txt. ... */ \param - @param \return - @return \sa - @see *!< - **< \file - @file
Well, right. But you still have to use /** @brief
As you dislike using \ I dislike using @ in text... ;-)
Thinking about this stuff, is there a document documenting current maintainers? If there is, I know who to bug for documentation in the code ;-) We do have authors to a lot of files that are no longer contributing because of forks...
/O