Share

DoxyComment

Tracker: Feature Requests

5 Tips for extra options - ID: 1527711
Last Update: Comment added ( stinos )

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)


Pieter ( the_roggy ) - 2006-07-24 12:10

5

Open

None

Nobody/Anonymous

VS2005 add-in

None

Public


Comment ( 1 )

Date: 2008-12-05 07:53
Sender: stinos

everything you want can be achieved by implementing a custom provider.


Attached File

No Files Currently Attached

Change

No changes have been made to this artifact.