Package org.odpi.openmetadata.reports.messages

Class MessagesAndCodesReport

java.lang.Object

org.odpi.openmetadata.reports.messages.MessagesAndCodesReport

public class MessagesAndCodesReport
extends Object

MessagesAndCodesReport generates the markdown documentation for every message that Egeria can produce. It is run from the gradle build so that the documentation is regenerated whenever a message set changes.

It takes two arguments:

• the root directory of the Egeria repository - the source tree that is scanned for message sets;
• the directory that the documentation is written to - by default the messages-and-codes directory at the root of the repository.

Constructor Summary

Constructors

Constructor	Description
MessagesAndCodesReport()

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)	Generate the documentation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MessagesAndCodesReport

public MessagesAndCodesReport()

Method Details

main

public static void main(String[] args)

Generate the documentation.

Parameters:

args - the root directory of the repository, followed by the directory to write to