search

DomingoGP / bgrabitmap_pasdoc

Pasdoc generated documentation for bgrabitmap
1 stars 1 forks source link

Thanks #1

Open rchastain opened 6 months ago

rchastain commented 6 months ago

Hello sir.

Thanks for sharing the documentation and the method used to generate it.

With your permission I put it online on my personal website:

https://msegui.net/doc/bgrabitmap/index.html

Regards.

Roland

DomingoGP commented 6 months ago

Hi Roland

You are welcome!

With your permission I put it online on my personal website:

From my side there is no problem, but maybe you should ask @circular17 who is the author of the package and the documentation.

I want to note that this is just a proof of concept to suggest to the author of bgrabitmap to use pasdoc to generate the documentation and that I will not maintain it. Circular17 is currently improving the documentation in the development version of bgrabitmap and may be He will release an improved official version.

issue in bgrabitmap https://github.com/bgrabitmap/bgrabitmap/issues/228

Best regards Domingo.

circular17 commented 6 months ago

Hi Rolland,

Sure it is nice to have an online documentation. About this subject I have some information to share.

I am working on the documentation indeed. I'm copying and adapting the proof of concept of Domingo, but in bgrabitmap repository, in the /doc folder in the dev branch.

I am adapting the comments in BGRABitmap for pasdoc so there will be updates soon on this. Any help in doing that is welcome.

I am also making changes to pasdoc itself so that it will be adapted to BGRABitmap:

This allows to generate the documentation with minimal bash scripting. These changes are not merged yet into pasdoc, but are in my fork of the repository. You will need it to generate using the script in bgrabitmap/doc folder.

You may want to generate a documentation that is specific to mseGUI, as this is suggested by the URL you've provided. pasdoc can indeed generate a different documentation depending on specified compiler directives.

At the same time, a website for BGRABitmap is in construction: https://bgrabitmap.web.app/ also accessible as https://bgrabitmap.github.io/ and the generated documentation will be there, but not generated for a specific GUI or system. Any help designing the website is welcome.

rchastain commented 6 months ago

Any help designing the website is welcome.

Thank you for the useful informations. I gave a try to your generation system. It works fine, excepted that I don't have dot. What is it?

DomingoGP commented 6 months ago

Hi,

It works fine, excepted that I don't have dot. What is it?

You need to install https://graphviz.org/ , there is a command dot.exe in the bin folder.