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

Open Source Development Extension Development
, ,
21

what is this :point_up:

22

@Prem_Gupta

IMG_20241126_235103
IMG_20241126_235103964×388 50.6 KB

IMG_20241126_234951
IMG_20241126_2349511080×128 37.5 KB

1 Like
23

@AkshatRana Very good work.

24

The generate does not work with large extensions.

1 Like
25

Yes, I mentioned it here:

1 Like
26

How many blocks are there in the extension?

27

29 blocks

28

Disk size of the extension?

29

Size is 77.8 KB
com.bosonshiggs.chatflow.aix (75.9 KB)

30

For me, only 70 blocks are generated. The rest are skipped. Still not generating a helper block for me.

31

Your extension correctly generates 29 blocks for me.

32

May you please send the extension here or in the PM?

33

I just tried with the extension having 270+ blocks and it generated all of them.
PS: The designer property block generation is yet to be tested.

34

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:

2 Likes
35

I already know why it doesn't generate all the blocks. The problem is that if the setter and the getter have the same name, only the getter is generated. Also does not generate helper blocks.

Test extension:

pl.patryk_f.helperstest.aix (6.3 KB)

Blocks:

image

From dokumentation:

image
image547×899 21.9 KB

36

Thanks for reporting the errors. I'll be fixing it in the next update.
But the helper blocks are being generated for me:-

image
image580×525 20.1 KB

image

It looks like the website is being run on old cache, as I have removed hr tags (that draws a divider) from the extension. Use a different browser or clear the cache.

37

Depreciated ? Should be "Deprecated" ?

1 Like
38

They didn't show up on my v1.5 page. Also, shouldn't they be attached to function blocks or properties, just like they are in the block editor?

39

@Patryk_F I have fixed the issue as addressed by you.

However, this is not in my current plan but I will try to add this in the coming updates.

Please clear the cache of the browser or use a different one. The helper block are being generated for me.

40

In Edge the generation of helper blocks works, in Chrome it does not work despite clearing the cache and cookies. Chrome also does not display buttons to download individual blocks.