Extension Document Generator - Generate Docs For Your Extension In A Single Click

Are you an extension developer? If so, you know how tedious it can be to properly document all the blocks and functionality in your extensions. The manual process of capturing screenshots, describing each block, and compiling it into comprehensive documentation is very time-consuming.

Well, there’s good news! A new tool called the Extension Documentation Generator makes it incredibly easy to automatically generate complete documentation for your AIX extensions with just a single click.

:sparkles:Features

With this handy tool, all you have to do is upload the extension here and this tool will analyse the extension and produce a full set of documentation, including:

  • Detailed descriptions of every block in your extension
  • Clear images/screenshots of each block’s appearance
  • Listings of the block properties, inputs, and outputs

The generated documentation is professionally formatted so that you can easily share it with the community.

Not only does this save you huge amounts of time and effort compared to manually documenting everything, but it ensures your documentation is comprehensive and accurate. No more unintentionally leaving out important details!

:warning: Important

:warning: This tool does not store your extension anywhere nor does the developer of this website have access to any extension uploaded here. But still, if you are insecure about uploading your paid extension here, you can simply delete classes.jar and AndroidRuntime.jar from your extension (.aix) file before uploading it here.

Currently helper blocks are not supported by this tool. However, I’ll look forward to add support for it in future.

Access The Tool

11 Likes

Nice work.

@Akshat_Rana Very Nice, Awesome :rocket::heart_eyes:

but here some problem/bug with it.
it can not write proper Events with extension name. pls fix it :mag_right:.

New Update v1.1


→ Changed block colours. Now they are the same as in AppInventor2.
→ Added option to save documentation as a PDF file.
→ Fixed the extension name not written on Event Blocks.

Clear cache and start using :fire:

@Akshat_Rana Very Nice, Awesome :rock: :astonished:

You can also add a button for other buil*ders for there own blocks color. it’s also helpful for extensions developer.

New Update v1.2


→ Fixed alignment of the Function block’s parameter text.
→ Minor bug fixes and performance enhancement.

Clear cache and start using :fire:

4 Likes

New Update v1.3


→ Added colour scheme support for different builders.
→ Navbar and spelling errors fixed.

Clear cache and start using :fire:

1 Like

It was most wanted feature for me.
Thanks a bunch.

New Update v1.4


:new: New Features:

  • :jigsaw:Helper Block Support: The tool now supports generating documentation for helper blocks.

This feature is still in its test phase. Any suggestions or error reports regarding this feature are welcome.

:wrench: Improvements:

  1. Optimized Block Image Size :framed_picture::
  • Reduced the dimensions and disk size of generated block images to align with App Inventor’s ideal block size.
  • This ensures your blocks look cleaner, lighter, and perfectly sized for documentation.
  1. UI Enhancements :iphone::
  • Updated the user interface for a smoother, more intuitive experience.

Clear cache and start using :fire:

1 Like

New Update v1.5


:new: New Features:

  • :jigsaw:Single Block Download: The tool now supports downloading a single block too.

:wrench: Improvements:

  1. Removed hr tag from documentation
  2. Changed order of block generation from methods > events > properties to events > methods > properties
  3. Fixed skipping of some blocks (tested with 270+ blocks extension)
  4. Fixed minor bug fixes and spelling mistakes.

Clear cache and start using :fire:

1 Like