Android Question how to create App documentation developed with B4A

Roberto P.

Well-Known Member
Licensed User
Longtime User
hello,
is there a way to create documentation of applications created with B4A? simle to understand Java doc or other tools that generate documentation from the tags in the code development?
thanks
 
Sort by date Sort by votes

Roberto P.

Well-Known Member
Licensed User
Longtime User
you can only do with a library?
well, can you do me a small example? as the document is generated?
thank you very much
 
Upvote 0

warwound

Expert
Licensed User
Longtime User
I added basic support for generating BB code and HTML reference for .b4a and .bas modules to my XML2BB script.
It's not perfect but is better than nothing!

Here's an example:

B4X: 
'   A comment that is not immediately followed by a Sub is ignored/not parsed

'   A comment line immediately preceeing a Sub will be parsed as a comment for the Sub
'   GetSum accepts two integer paramters and returns the sum of those two parameters
Sub GetSum(Value1 As Int, Value2 As Int) As Int
   Return Value1+Value2
End Sub

And the BB code generated is:

ExampleProject
  • GetSum (Value1 As Int, Value2 As Int) As Int
    A comment line immediately preceeing a Sub will be parsed as a comment for the Sub
    GetSum accepts two integer paramters and returns the sum of those two parameters

ExampleProject is the name of the .b4a module i upload: ExampleProject.b4a

There's a bit more info here: http://www.b4x.com/android/forum/threads/java-auto-generate-library-documentation-with-xml2bb.18564/.

Martin.
 
Upvote 0
You must log in or register to reply here.
Menu
Log in
Register
Cookies are required to use this site. You must accept them to continue using the site. Learn more…