Menu AADoc About Documentation Example Feedback

AADoc

A simple, free and easy to use documentation tool for Automation Anywhere RPA Tool

Installation

pip install aadoc

Prepare input files

In AA, Task Editor, Go to File Menu and Select Save as Text File

Learn how to export code in text format

Generating Documnetation

C:\>aadoc "folder path where inputs are present" "destination folder path for documentation"

Documentation

You can change the sequence as you wish, documentation will be generated accordingly


@author

For documenting Author / Developer information

@author Dilli Babu R <dillir07@outlook.com>

@date

For documenting created date or modified date

@date 25-July-2020

@copyright

For documenting copyright information

@copyright Name

@description

For documenting the description for any item

@description this command takes care of checking if text box is loaded or not. If it is not loaded then BOT will wait for 180 seconds and then will do a retry. This is done 3 times.

@file

For documenting file information

@file Validate User inputs.atmx

@function

For documenting function or command information, usaully combined with description tag

@function name of the function or command

@license

For documenting license information

@license MIT

@param

@param {Variable Type} Variable Name - Variable description

@param {Text} vUserToken - Stores User's Secure token to communicate with Web Service

@param {Integer} vTimeout - Minimum timeout between each API call. (in Seconds)

@requires

For documenting Dependency information

@requires Database_connection.mbot

@since

For documenting when a functionality is added

@since v2.0 - User input is Automatically validated before API Call

@version

For documenting Version information

@version 2.0


Sample Home Page

Project - Documentation
Created On: 08-Mar-2020
Files:
Write Data to Database

File Path: C:\temp\aa_doc\Input\Write Data to Database.txt
No of Comment lines: 43
Total Number of lines: 102

Connect to WebService

File Path: C:\temp\aa_doc\Input\Connect to Webservice.txt
No of Comment lines: 36
Total Number of lines: 108

Sample File Documentation

Write Data to Database
Date: 15-JAN-2018
This file contains code that chooses connection to database, then verifies the connections, reads the connection params and finally closes the connection.
Author: Dilli Babu R
Version: 2.5
License: Apache v2.0
Document Histroy
Since: 1.0 - Support for mouse events added
Since: 2.0 - Added drag and drop Support
Parameters
Name Type Description
vConnectionName Text Name of the connection
vConnectionType Text Type of the connection
vConfigUrl Text URL of the connection
vCredentialsName Text Name of the Credentials in CW
Select connection to Database
Selects the connection to the database by going over all the available connections.
Parameters
Name Type Description
vConnectionName Text Name of the connection
vConnectionType Text Type of the connection
vConfigUrl Text URL of the connection
vCredentialsName Text Name of the Credentials in CW
DB Connection check
Verifies the connection if it is connected correctly or not, and Nisi aliqua mollit sint labore pariatur occaecat amet.
This is a sample example.
By mixing these the AADoc tags in meaningful sequence we can create an effective documentation

Feedback







Thank you

Please feel free to let me know if you like to see some feature added or if you face any issues.

You can also open issues in Github.

Licensed under GPLv3, click here to learn more.