Source code documentation can be a useful source for understanding software. Doxygen  is a well known program that generates well formatted documentation out of source code comments. It allows to include handwritten uml files via a tool called plantUM. I wrote a small abap program, that extracts the documentation

out of all developments objects of a development package and creates c header files that are suitable for doxygen processing. The abap program

start doxygen and produces the documentation. As a prerequisite, you need to have doxygen (and plantUML) installed, doxygen needs to be in the path

and on your client workstation you need a folder c:\srtc. The documentation is extracted form the method/class/ddic documentation of each object.

You can use all doxygens tag e.g. you can use the mainpage tag to create an overview page of your development class. I bundled all the technical

stuff here. Please note I wrote this tool to learn the details on a specific abap package. The tool comes without anay warranty or support. However

if you find it usefull but need some enhancements please let me know.

Kind regards Markus

To report this post you need to login first.

5 Comments

You must be Logged on to comment or reply to a post.

  1. Thomas Fiedler

    Hi Markus,

    we are currently working on the productive version of ABAP Doc generation integrated in ABAP in Eclipse. So no workarounds needed anymore as this will be part of the standard developer tool.

    Regards,

    Thomas.

    (0) 
  2. Jacques Nomssi

    Hello Markus,

    thanks for sharing.

    Your code requires Netweaver 7.4 SP08, but it is was easy to adjust for SP05 as it only use one new feature (inline DATA definition in SELECT INTO …).

    I have never used Doxygen but I could subclass CL_UML_CLASS_DECORATOR to export the standard UML Class Diagram output (report UML_CLASS_DIAGRAM) to PlantUML.

    best regards,

    JNN

    (0) 

Leave a Reply