Book a Demo

Author Topic: is there a way to filter out doxygen comments?  (Read 3619 times)

edroi

  • EA Novice
  • *
  • Posts: 8
  • Karma: +0/-0
    • View Profile
is there a way to filter out doxygen comments?
« on: November 25, 2009, 02:59:46 am »
Hi

Can anybody suggest a way to filter out doxygen tags during reverse engineering (except of getting rid of them manually of course).
EA picks up comments quite nicely from the existing codebase but unfortunately it comes together with doxygen tags. It would've been nice to filter them out to make model elements description readable

Thanks
Eugene

Eve

  • EA Administrator
  • EA Guru
  • *****
  • Posts: 8110
  • Karma: +119/-20
    • View Profile
Re: is there a way to filter out doxygen comments?
« Reply #1 on: November 25, 2009, 08:49:41 am »
You didn't say what language you are using.  But C++ has options for comment style.  Depending on how you have formatted your doxygen comments the javadoc style may do what you want.

edroi

  • EA Novice
  • *
  • Posts: 8
  • Karma: +0/-0
    • View Profile
Re: is there a way to filter out doxygen comments?
« Reply #2 on: November 25, 2009, 12:09:10 pm »
Thanks, Simon
It is C++ indeed
What if I already have code documented not  in javadoc style.
Can anything be done with that?


Eve

  • EA Administrator
  • EA Guru
  • *****
  • Posts: 8110
  • Karma: +119/-20
    • View Profile
Re: is there a way to filter out doxygen comments?
« Reply #3 on: November 26, 2009, 08:36:23 am »
Then EA doesn't know how to extract the metadata out of your comments.

I was just hoping that you had used the @author doxygen convention instead of \author.

edroi

  • EA Novice
  • *
  • Posts: 8
  • Karma: +0/-0
    • View Profile
Re: is there a way to filter out doxygen comments?
« Reply #4 on: November 26, 2009, 09:00:26 am »
Unfortunately not.
It is actually \tag style comments.
Do you know (or maybe you can point me out )whether there is a way to hook a custom filter (or a converter) to the reverse-engineering module to filter out (or convert) the tags ?

Eve

  • EA Administrator
  • EA Guru
  • *****
  • Posts: 8110
  • Karma: +119/-20
    • View Profile
Re: is there a way to filter out doxygen comments?
« Reply #5 on: November 30, 2009, 09:23:16 am »
Then no, there is no way to get EA to process the doxygen metadata using the slash style.