Question

We have a C# project which for historical reasons uses both Doxygen and Visual Studio style comments in the same code. Has anyone tried to systematically translate one standard to another, preferably to the common XML subset?

I guess it would not be too difficult to write a script to cover the most common features, but I would not like to reinvent the wheel.

Was it helpful?

Solution

I know it has been a while since you asked, but I ran into the same problem. Here is my 10 minute open source project that should make the converting a little less painless. :-) Extensions are welcome!

https://code.google.com/p/doxygentoxmlconverter/

OTHER TIPS

The original answer to this question also did only included a link, so I do the same:

First the link above is old, here is a newer version of the link: Link,

Beside I have added a completely new AWK script variant of the solution: Link

Since the original python script did not work for me because in my case we had "\brief" notation instead of "@brief", so I wrote my own. (I do not speak python yet)

One important key feature is that you can easily add tag translation, or skip some of them:

translate["\\fn"]     = "skip";
translate["\\def"]    = "skip";
translate["\\class"]  = "skip";
translate["\\enum"]   = "skip";
translate["\\struct"] = "skip";
translate["\\author"] = "skip";
translate["\\brief"]  = "summary";
translate["\\param"]  = "param";
translate["\\return"] = "returns";

Later on I also found the new version of the original python script, so I hope no one have to start it from scratch again!

If I had found “just the link” to the new script earlier, it could protect me from some headache.

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top