A simple, free and easy to use documentation tool for Automation Anywhere RPA Tool
pip install aadoc
In AA, Task Editor, Go to File Menu and Select Save as Text File
Learn how to export code in text formatC:\>aadoc "folder path where inputs are present" "destination folder path for 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
Created On: | 08-Mar-2020 |
---|
No of Comment lines: | 43 |
---|
Total Number of lines: | 102 |
---|
No of Comment lines: | 36 |
---|
Total Number of lines: | 108 |
---|
Date: | 15-JAN-2018 |
---|
Author: | Dilli Babu R |
---|
Copyright: | Dilli Babu R |
---|
Version: | 2.5 |
---|
License: | Apache v2.0 |
---|
Since: | 1.0 - Support for mouse events added |
---|
Since: | 2.0 - Added drag and drop Support |
---|
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 |
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 |
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.