Automatic documentation with mule

1. Automatic documentation with Mule

2. Documentation is very important aspect in our software project which explains how it operates or
how to use it, and may mean different things to people in different role. It identify attributes,
capabilities, characteristics, or qualities of a system or project.
Do you know your Anypoint Studio has a feature to generate documentation of our Mule project ??

3. Anypoint Studio simplifies the approach for application documentation. It allows to generate an
HTML based documentation for the application by click of a button.
It supports the ability to import and export your projects or various project elements and has the
ability to document each of the flows, elements, code and it’s attributes.

5. Yes .. We can .. I will show you this trick .. How ??

6. Anypoint studio has an inbuild document generator plugin available??

7. So, let’s consider we have following flow:-

8. Mule config will be
You can see in the code we have written the description of the components in the doc:name
attributes .. Now when document will be generated we will be getting the description of the
component in the documentation

9. Now, in anypoint studio we will see a plugin that is for document generation :-
Now, let’s click on the plugin shown in the red mark above

10. It will ask for a location to generate our documentation files
We select a path and click on Generate Studio Documentation.
In our case the documentation will generate in C:Tempdocs folder

11. The document is getting generated in the given folder

12. We will find folders and a index.html files has been generated in the given folder as Studio
generates, then saves the documentation for your project as an index.html file on your local
drive.
If we double-click to open the index.html, file will open in our default Web browser as above.

13. Thus, the documentation contains every single flows and shows both the graphical flow design
and XML configuration code of each individual flows within the application.
You can see it also contains our code and description of our flows and components both graphically
and also in xml format

14. In my next slide I will bring some other techniques in Mule implementation .
Hope you have enjoyed this simpler version.
Keep sharing your knowledge and let our Mule community grow 