Article

How to make ABLDoc compatible with Javadoc style comments

Information

 
Article Number000093570
EnvironmentProduct: OpenEdge
Version: 11.5, 11.6, 11.7
OS: All supported platforms
Question/Problem Description
The Progress ABLDoc documentation generation tool uses the following style for comments:
/*-----------------------
    Purpose:
    Notes:

    @param
    @return
*/

However, the Javadoc style for comments (generally used by other documentation generators) is as follows:
/**
* Purpose:
* Notes:
* @param
* @return
*/

Using this style of comments, with leading asterisks, with ABLDoc causes the comments (purpose, notes, etc) not being picked up by the generator.
Steps to Reproduce
Clarifying Information
Error Message
Defect/Enhancement Number
Cause
Resolution
Attached is a white paper which describes how to enable ABLDoc to recognize the Java style comment format. 
And a .rar file containing files that enables the extension of the comment parser to support Java style comments.
Workaround
Notes
Reference to other documentation:
Community: Supporting Java Style Comments in ABLDoc
Article 000041203: Does Progress provide a tool similar to javadoc for OpenEdge ABL?
Article 000060834: How to use ABLDoc?
Last Modified Date12/28/2018 10:18 AM


Feedback
 
Did this article resolve your question/issue?

   

Your feedback is appreciated.

Please tell us how we can make this article more useful. Please provide us a way to contact you, should we need clarification on the feedback provided or if you need further assistance.

Characters Remaining: 1025