Solved

How can i  add D-Oxygen comments to any cpp file using perl script?

Posted on 2008-06-19
5
170 Views
Last Modified: 2011-10-19
Hi Experts,

here with this question i has attached a document which contains a question of how to insert a D-Oxygen comments and do some operations.Please give me the script how to do this and also suggest me any link or tutorial which describes about this??

Thank you.
Inserting-D.doc
0
Comment
Question by:rakeshreddy42
[X]
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
  • 3
  • 2
5 Comments
 
LVL 29

Expert Comment

by:pepr
ID: 21829340
If you mean Doxygen (http://www.doxygen.org/), then have a look at

Documenting the code (http://www.stack.nl/~dimitri/doxygen/docblocks.html),
Special Commands (http://www.stack.nl/~dimitri/doxygen/commands.html), and
Getting started (http://www.stack.nl/~dimitri/doxygen/starting.html).

All of the topics are parts of the Doxygen Manual (http://www.stack.nl/~dimitri/doxygen/manual.html).
0
 
LVL 29

Expert Comment

by:pepr
ID: 21829355
To add, it is possible to run Doxygen also for completely undocumented code. It extracts the structure and dependencies plus adds some general texts in the chosen human language. You possibly want to read the generated Doxyfile. You can switch on some features like generating call graphs, etc.
0
 

Author Comment

by:rakeshreddy42
ID: 21843575
Hello Pept,


Please could you send me the script for the above solution
0
 
LVL 29

Accepted Solution

by:
pepr earned 500 total points
ID: 21844346
rakeshreddy42: I have stopped to use Perl, so my working knowledge is rather weak (using Python instead). Anyway, I would store the comment fragments into string variables and put it do detected places in the sources. The question is how to detect say beginning of functions/methods. It depends on situation.

I personally prefer to put the most comments into .cpp files and let the function/method signatures in .h uncommented (self documenting identifiers only or very brief non-Doxygen comments to the end of the line).

Another question is: "Why do you want to add the documentation comments automatically when it must be filled with some meaningfull text?" It could be more efficient to use some decent editor that support more clipboards (like jEdit) and include the comments on the fly.
0
 

Author Comment

by:rakeshreddy42
ID: 21844747
Hello there,

Can anyone help me reagarding the above problem?????????

If any help will be really appreciated.

Rakesh.
0

Featured Post

Technology Partners: We Want Your Opinion!

We value your feedback.

Take our survey and automatically be enter to win anyone of the following:
Yeti Cooler, Amazon eGift Card, and Movie eGift Card!

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Article by: SunnyDark
This article's goal is to present you with an easy to use XML wrapper for C++ and also present some interesting techniques that you might use with MS C++. The reason I built this class is to ease the pain of using XML files with C++, since there is…
Whatever be the reason, if you are working on web development side,  you will need day-today validation codes like email validation, date validation , IP address validation, phone validation on any of the edit page or say at the time of registration…
Learn how to match and substitute tagged data using PHP regular expressions. Demonstrated on Windows 7, but also applies to other operating systems. Demonstrated technique applies to PHP (all versions) and Firefox, but very similar techniques will w…
The goal of the video will be to teach the user the concept of local variables and scope. An example of a locally defined variable will be given as well as an explanation of what scope is in C++. The local variable and concept of scope will be relat…

729 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question