Try OpenEdge Now
skip to main content
Online Help
Introducing the ABL Editor : Tasks : Compiling, testing, and running ABL programs : Generating ABLDoc documentation : Customizing ABLDoc output : Adding a custom serializer class
Adding a custom serializer class
To generate a custom format, you can add a custom serializer to the ABLDoc framework. You can use the ABLDoc model to get the file information and serialize it to the format you want. When output is generated, your custom serializer class is called and not the default HTML serializer.
1. Copy the abldoc-core.jar file from {DLC_HOME}\oeide\eclipse\plugins\com.progress.openedge.pdt.abldoc.core_11.5.0.00\lib into an Eclipse project or a folder.
2. Create a class that implements the IDocSerializer interface (available in the abldoc-core.jar file)
3. Override the generateDoc methods and add your logic for generating the custom format.
Note: The generateDoc method has an argument RootNode that has all the packages and files. All the children of this node can be viewed using NodeVisitor.
4. Compile the class with abldoc-core.jar in the classpath.
To add a custom serializer from Progress Developer Studio for OpenEdge, go to DLC_HOME}\oeide\eclipse\plugins\com.progress.openedge.pdt.abldoc.ui, and edit to add new properties as follows:
serializer: fully qualified name of the class
serializerpath: the absolute path of the folder where this class is located. If you generate the ABLDoc documentation, the custom serializer that is added, is called.