Some tips for extra options, wich would make it
unnececarry for a lot of people (including me) to
write an extension:
1) define the character before ex. "param" by a
parameter instead of always '\', I would like to
override with '@'.
2) specify, with parameters, whether you want compact
or less compact documenting. I like this style:
/// First sentence, bofore the point, is the brief.
/// After the first sentence, the detailed explanations
/// can be put. Blablabla...
///
/// @param sSectionName The name of the section
/// @param sComment The comment to be included.
/// @param pIndex Returns the index of the
/// section.
Could be parametrised with 3 Yes/No options:
- Include explicid brief section Yes/No
-> If set to No, \brief isn't included
- Use inline descriptions Yes/No
-> If set to Yes, No \n is placed after eg. "///
@param sSectionName "
- Divide sections by newlines Yes/No
-> If set to No, no \n's between the diferent
sections (parameters)
everything you want can be achieved by implementing a custom provider.