1
Suggestions and Requests / Re: Request support for Doxygen Comments
« on: October 07, 2007, 08:30:29 pm »
I set up my code engineering to forward engineer only, and that C++ comments get replaced. Basically I took the Doxygen template from the Wiki and made it work how I wanted after a lot of head bashing
This implies the following:
* All element documentation goes in the model
* For extra doco, put the inline Doxygen comment after the curly brace at the start of the C++ method, so it doesnt get clobbered in the forward engineering
Pros:
- I can add non-core variables and methods to my C++ classes in the code without cluttering the model
- Core variables and methods are documented in the model and the Doxygen (we have tools that scan the XMI to report which items are undocumented)
Cons:
- Renaming a method or member leaves the old method in the C++
- ordering generally doesnt stay nice and neat in the generated source
- It cant update the FILE header comment, only class and method
- it cant do Doxygen comments on the line before member fields, they have to be inline after ( the ///< style) because the Code generator otherwise gets very badly confused
It would be much nicer if the synchronizer worked properly though...
HTH
This implies the following:
* All element documentation goes in the model
* For extra doco, put the inline Doxygen comment after the curly brace at the start of the C++ method, so it doesnt get clobbered in the forward engineering
Pros:
- I can add non-core variables and methods to my C++ classes in the code without cluttering the model
- Core variables and methods are documented in the model and the Doxygen (we have tools that scan the XMI to report which items are undocumented)
Cons:
- Renaming a method or member leaves the old method in the C++
- ordering generally doesnt stay nice and neat in the generated source
- It cant update the FILE header comment, only class and method
- it cant do Doxygen comments on the line before member fields, they have to be inline after ( the ///< style) because the Code generator otherwise gets very badly confused
It would be much nicer if the synchronizer worked properly though...
HTH