Book a Demo

Author Topic: Round tripping code with Doxygen style comments  (Read 3864 times)

Dave J.

  • EA Novice
  • *
  • Posts: 2
  • Karma: +0/-0
    • View Profile
Round tripping code with Doxygen style comments
« on: November 21, 2014, 11:56:57 pm »
Hi,
It is a requirement for the code base that I am working on to employ Doxygen comments. When designing my class hierarchy I wanted to genrate the correct Doxygen documentation from the class, method and attribute notes in my EA model.
By using the guidelines in this link http://community.sparxsystems.com/tutorials/538-10doxygen-code-templates-for-enterprise-architect I can generate the correct documentation. My issue is that when I synchronise the code with the model my Doxygen comments for method parameters (@param) don't result in the method parameter notes being updated. Instead, they appear in the method notes.
I did a little investigation and found the following paper from the LSST project https://dev.lsstcorp.org/trac/wiki/EaIngestNeeds. This seemed to suggest that it is possible to direct the parameter tagged comments to the actual parameter notes in the model. In my subsequent efforts this did not seem to be the case.

Is this this possible? Does anybody have any experience?