Solved

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

Posted on 2008-06-19
5
165 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
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 28

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 28

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

Gigs: Get Your Project Delivered by an Expert

Select from freelancers specializing in everything from database administration to programming, who have proven themselves as experts in their field. Hire the best, collaborate easily, pay securely and get projects done right.

Question has a verified solution.

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

Suggested Solutions

Title # Comments Views Activity
Problem with SqlConnection 4 168
Regular Expression to find a line feed 1 47
Regex - Ignoring Spaces 7 25
REGEX HELP 11 40
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…
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…
The viewer will learn how to user default arguments when defining functions. This method of defining functions will be contrasted with the non-default-argument of defining functions.
The viewer will be introduced to the member functions push_back and pop_back of the vector class. The video will teach the difference between the two as well as how to use each one along with its functionality.

776 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