Solved

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

Posted on 2008-06-19
5
163 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
  • 3
  • 2
5 Comments
 
LVL 28

Expert Comment

by:pepr
Comment Utility
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 28

Expert Comment

by:pepr
Comment Utility
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
Comment Utility
Hello Pept,


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

Accepted Solution

by:
pepr earned 500 total points
Comment Utility
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
Comment Utility
Hello there,

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

If any help will be really appreciated.

Rakesh.
0

Featured Post

Enabling OSINT in Activity Based Intelligence

Activity based intelligence (ABI) requires access to all available sources of data. Recorded Future allows analysts to observe structured data on the open, deep, and dark web.

Join & Write a Comment

As most anyone who uses or has come across them can attest to, regular expressions (regex) are a complicated bit of magic. Packed so succinctly within their cryptic syntax lies a great deal of power. It's not the "take over the world" kind of power,…
Email validation in proper way is  very important validation required in any web pages. This code is self explainable except that Regular Expression which I used for pattern matching. I originally published as a thread on my website : http://www…
Explain concepts important to validation of email addresses with regular expressions. Applies to most languages/tools that uses regular expressions. Consider email address RFCs: Look at HTML5 form input element (with type=email) regex pattern: T…
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…

772 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

Need Help in Real-Time?

Connect with top rated Experts

11 Experts available now in Live!

Get 1:1 Help Now