Automatic Documentation for modules

Download and share automation modules and examples.
bberrabah
Posts: 24
Joined: Wed Dec 20, 2017 6:18 pm

Automatic Documentation for modules

Post by bberrabah » Tue Feb 06, 2018 5:05 pm

Hello forum;
I want to know if is it possible to generate some documentation for each module (for example that lists all the variables used by the module).
Any tools like javadoc ? for .Net environnements?
Best regards

User avatar
odklizec
Ranorex Guru
Ranorex Guru
Posts: 3930
Joined: Mon Aug 13, 2012 9:54 am
Location: Zilina, Slovakia

Re: Automatic Documentation for modules

Post by odklizec » Wed Feb 07, 2018 8:21 am

Hi,

I'm afraid, there is no such tool specifically build for Ranorex. I would suggest to create a feature request here:
https://uservoice.ranorex.com/forums/15 ... ve-ranorex
Pavel Kudrys
Ranorex explorer at Descartes Systems

Please add these details to your questions:
  • Ranorex Snapshot. Learn how to create one >here<
  • Ranorex xPath of problematic element(s)
  • Ranorex version
  • OS version
  • HW configuration

User avatar
jarrettmk
Posts: 9
Joined: Wed Sep 19, 2018 6:10 pm

Re: Automatic Documentation for modules

Post by jarrettmk » Thu Sep 20, 2018 11:57 pm

If you go into the Build tab of the Properties for your projects there is a checkbox you can enable for "XML documentation file" in the Output section.

You can then download Sandcastle Help File Builder here: https://github.com/EWSoftware/SHFB

It has pretty straightforward step-by-step instructions on how to install and run it. You will have to add a couple of the Ranorex DLLs as References within the tool to get it to build the file correctly.

This will pickup the information in your Summary tags so make sure your methods are notated as you want them to show up in your documentation.
Jarrett Karyshyn
Quality Assurance & Automation Engineer
USA - EST (UTC−05:00)/EDT (UTC−04:00)
Image