Project Documentation Tool?

P

PhilNewbie

Member
I'm returning a B4X project after a break and as a way of familiarising myself with the project structure, classes etc I thought a good place to start would to be to document it all. So while I was messing with ChatGPT I asked it if the was a tool do this for me and it suggested there was one written by Erel called B4XPagesBuilder. However, I can't find any reference to it within the forum or on the website generally. Does this really exist and if so how can I get it?

This is what chatGPT said:
Yes, there is a tool called "B4XPagesBuilder" that can automatically generate documentation for a B4X project's structure. B4XPagesBuilder is a free and open-source tool developed by Erel Uziel, the creator of the B4X programming language.

B4XPagesBuilder can generate a detailed report of a B4X project's structure, including the number of windows, classes, modules, and other components. The report can also include information about the relationships between components, such as which windows are related to which classes.

To use B4XPagesBuilder, you will need to download and install it on your computer. Once installed, you can open a B4X project in B4XPagesBuilder and generate a report by clicking on the "Generate Report" button. The report will be generated in HTML format and can be opened in a web browser.

Overall, B4XPagesBuilder can be a useful tool for documenting the structure of a B4X project, and can help developers better understand the relationships between components and the overall architecture of their application.
 
peacemaker

peacemaker

Expert
Licensed User
Longtime User
Strange that Google does not know it, but the bot is quoting...
 
aeric

aeric

Expert
Licensed User
Longtime User
PhilNewbie said:
b4xpagesbuilder-update-june-2018.92503/
Click to expand...
I think B4XPages was introduced in June 2020. How come the tool updated in 2018?

[B4X] [B4XPages] What exactly does it solve?

B4XPages makes many things simple and even trivial. As Android developers, we are dealing with these challenges for many years now so it might take us a while to understand how simple things can be. As explained in B4XPages tutorial, there are two purposes for B4XPages: Provide a cross...
www.b4x.com www.b4x.com
 
agraham

agraham

Expert
Licensed User
Longtime User
P

PhilNewbie

Member
aeric said:
I think B4XPages was introduced in June 2020. How come the tool updated in 2018?

[B4X] [B4XPages] What exactly does it solve?

B4XPages makes many things simple and even trivial. As Android developers, we are dealing with these challenges for many years now so it might take us a while to understand how simple things can be. As explained in B4XPages tutorial, there are two purposes for B4XPages: Provide a cross...
www.b4x.com www.b4x.com
Click to expand...
So are you saying that you think a documentation exists?
 
aeric

aeric

Expert
Licensed User
Longtime User
PhilNewbie said:
project structure, classes etc
Click to expand...
If we load the project, the structure is organized inside the IDE.

PhilNewbie said:
generate a detailed report of a B4X project's structure, including the number of windows, classes, modules, and other components
Click to expand...
If you want, you can open the project file using a text editor like Notepad to see the list of libraries used by the project.

I don't see the point having this information display in an external tool.

As a developer, I will write comments at top of a function and when I hover the function where it is used, the comment is shown. The IDE now support ability to peek the code in the class and right click to jump to the identifier. This is more useful.
 
A

Adrian Jansen

Member
Licensed User
Longtime User
I asked the same question just a while ago:

Program documentation

Hi All, Been involved in programmning for years, but new to B4J and in particular SQLITE database stuff. It occurs to me that it would be useful to have a place to store documentation with the code. Not individual inline comments, which are fine, but an overall view of how the program works...
www.b4x.com www.b4x.com

Found that if I just create a code module called something like "Docs" and then put a collection of entries between #if ... #end if tags, you can write anything you like.
Just dont define a Conditional Symbol in the Project|Build Configurations using one of your tag names.

Something like:
B4X: 
#if MyNotes

Can put anything in here.
MyNotes is not defined, so stuff in here is not compiled

#end if

#if ToDo
Any ToDo comments here
#End If

You can even create Subs with heading names like

B4X: 
Sub Class_Header1

#if h1

Anything you want

#end if

End Sub

And those dummy subs show up in the Modules list, so you can jump to them from there
 
You must log in or register to reply here.
Top