Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
I’m developing a large C++ program and I’ve now decided to document it with Doxygen.
There are plenty of classes, methods, functions, macros and so on. Therefore I’m searching for software that would scan my source tree and insert Doxygen comment blocks on top of every “documentable item” to let me edit them later and add details such as method descriptions and so on.
Does any such software exist?
I’m under GNU/Linux with the Code::Blocks IDE, so no Visual Studio plugins are needed.
You can set Doxygen to extract non-documented items as well – that may do what you want without adding ANY comment blocks to the code yet.
After that you can create templates / macros (depends on your IDE) to create pre-formatted blocks for each type of item, as you slowly work through the code documenting items one by one.
[edit]
If you’re using Visual Studio, some introspection is available on the classes and other constructs in the file, that may help. Alternatively take a look at Doxycomment – it might be some of what you want.