Solved

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

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

Is Your Active Directory as Secure as You Think?

More than 75% of all records are compromised because of the loss or theft of a privileged credential. Experts have been exploring Active Directory infrastructure to identify key threats and establish best practices for keeping data safe. Attend this month’s webinar to learn more.

Question has a verified solution.

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

Suggested Solutions

Title # Comments Views Activity
Need Regex Money No $ 5 68
Coldfusion RegEx 8 55
Need help decoding the following expressions 1 27
REReplaceNoCase help 1 11
Do you hate spam? I do, and I am willing to bet you do as well. I often wonder, though, "if people hate spam so much, why do they still post their email addresses on the web?" I'm not talking about a plain-text posting here. I am referring to the fa…
In the distant past (last year) I hacked together a little toy that would allow a couple of Manager types to query, preview, and extract data from a number of MongoDB instances, to their tool of choice: Excel (http://dilbert.com/strips/comic/2007-08…
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 viewer will be introduced to the technique of using vectors in C++. The video will cover how to define a vector, store values in the vector and retrieve data from the values stored in the vector.

929 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

12 Experts available now in Live!

Get 1:1 Help Now