automatic documentation with mule
TRANSCRIPT
![Page 1: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/1.jpg)
Automatic documentation with Mule
By Anirban Sen Chowdhary
![Page 2: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/2.jpg)
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 ??
![Page 3: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/3.jpg)
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.
![Page 4: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/4.jpg)
So, How can we document in Anypoint studio?
?
![Page 5: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/5.jpg)
Yes .. We can .. I will show you this trick .. How ??
![Page 6: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/6.jpg)
Anypoint studio has an inbuild document generator plugin available??
![Page 7: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/7.jpg)
So, let’s consider we have following flow:-
![Page 8: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/8.jpg)
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
![Page 9: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/9.jpg)
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
![Page 10: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/10.jpg)
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:\Temp\docs folder
![Page 11: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/11.jpg)
The document is getting generated in the given folder
![Page 12: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/12.jpg)
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.
![Page 13: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/13.jpg)
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
![Page 14: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/14.jpg)
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
![Page 15: Automatic documentation with mule](https://reader035.vdocument.in/reader035/viewer/2022062420/55c675ffbb61eb477a8b4651/html5/thumbnails/15.jpg)
Thank You