Sign in to follow this  
Followers 0
SiriusDG

AutoDoc Help

7 posts in this topic

Hi, I am just getting started with AutoIt, but if it continues to impress me as it has so far, I will be doing a lot of scripting in the next few years. I was trying to find an autodoc tool to support it, but have not had any luck. Looking through the code of the included libraries, the comments seem to strong suggest that you guys are doing autodoc in house... can you help me out here? Any suggestions or tools to download would be great. Thanx!!

David

Share this post


Link to post
Share on other sites



SiriusDG,

Welcome to the AutoIt forum. :oops:

an autodoc tool to support it

Pardon my ignorance, but what is an "autodoc tool"? :D

M23


Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind._______My UDFs:

Spoiler

ArrayMultiColSort ---- Sort arrays on multiple columns
ChooseFileFolder ---- Single and multiple selections from specified path treeview listing
Date_Time_Convert -- Easily convert date/time formats, including the language used
ExtMsgBox --------- A highly customisable replacement for MsgBox
GUIExtender -------- Extend and retract multiple sections within a GUI
GUIFrame ---------- Subdivide GUIs into many adjustable frames
GUIListViewEx ------- Insert, delete, move, drag, sort, edit and colour ListView items
GUITreeViewEx ------ Check/clear parent and child checkboxes in a TreeView
Marquee ----------- Scrolling tickertape GUIs
NoFocusLines ------- Remove the dotted focus lines from buttons, sliders, radios and checkboxes
Notify ------------- Small notifications on the edge of the display
Scrollbars ----------Automatically sized scrollbars with a single command
StringSize ---------- Automatically size controls to fit text
Toast -------------- Small GUIs which pop out of the notification area

 

Share this post


Link to post
Share on other sites

Do you mean is there a tool to allow you to click on stuff, then write the script for you? If that is the case then yes there is a tool but it doesn't work that well. In SciTE there is a tool called AU3Recorder. I've used that tool at first but found it to be very limiting. It won't work in IE windows, uses mouseclick (not controlclick), I could go on but you get the idea.

Share this post


Link to post
Share on other sites

I think the OP might be thinking of something similar to JavaDoc to be used with AutoIt3.


If I posted any code, assume that code was written using the latest release version unless stated otherwise. Also, if it doesn't work on XP I can't help with that because I don't have access to XP, and I'm not going to.
Give a programmer the correct code and he can do his work for a day. Teach a programmer to debug and he can do his work for a lifetime - by Chirag Gude
How to ask questions the smart way!

I hereby grant any person the right to use any code I post, that I am the original author of, on the autoitscript.com forums, unless I've specifically stated otherwise in the code or the thread post. If you do use my code all I ask, as a courtesy, is to make note of where you got it from.

Back up and restore Windows user files _Array.au3 - Modified array functions that include support for 2D arrays.  -  ColorChooser - An add-on for SciTE that pops up a color dialog so you can select and paste a color code into a script.  -  Customizable Splashscreen GUI w/Progress Bar - Create a custom "splash screen" GUI with a progress bar and custom label.  -  _FileGetProperty - Retrieve the properties of a file  -  SciTE Toolbar - A toolbar demo for use with the SciTE editor  -  GUIRegisterMsg demo - Demo script to show how to use the Windows messages to interact with controls and your GUI.  -   Latin Square password generator

Share this post


Link to post
Share on other sites

#5 ·  Posted (edited)

I think he means the tool used to generate the helpfile pages from the includes (although it doesn't really work that way (any more?)). This question is probably for Valik (or one of the other devs).

Edited by AdmiralAlkex

Share this post


Link to post
Share on other sites

Yes, looking for a JavaDoc style tool... the way we plan on using AutoIt is to generate a high level keyword testing system, with the details of actually interacting with the applications being hidden in the includes. I want to use the auto doc tool to generate living docs for the code for the automation engineers, and also to generate a living library of the high level keywords for the test engineers to know what is available to them for usage. I can tell by the comments in the included UDF libraries that such a system is in fact being used by someone there, so I just wondered if they could share the knowledge. Thanx!!

David

Share this post


Link to post
Share on other sites

#7 ·  Posted (edited)

Yes, looking for a JavaDoc style tool... the way we plan on using AutoIt is to generate a high level keyword testing system, with the details of actually interacting with the applications being hidden in the includes. I want to use the auto doc tool to generate living docs for the code for the automation engineers, and also to generate a living library of the high level keywords for the test engineers to know what is available to them for usage. I can tell by the comments in the included UDF libraries that such a system is in fact being used by someone there, so I just wondered if they could share the knowledge. Thanx!!

You can write such generator yourself. It's not so hard. It can be your first/starting learning application/lesson in Autoit :-)

I'm sure you will get much help here on the forum if you provide exact details of structure of comments in source/include files to be parsed.

Edited by Zedna

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!


Register a new account

Sign in

Already have an account? Sign in here.


Sign In Now
Sign in to follow this  
Followers 0