New feature: built-in documentation

Erel

Administrator
Staff member
Licensed User
Basic4android V2.00 will include a new built-in documentation feature.

Comments above subs, such as:


Will automatically appear in the pop-up window:




If you want to add a code example you can use <code> tags:
B4X:
'Parses a raw mail message and returns a Message object
'Mail - The mail raw text
'AttachmentsDir - Attachments will be saved in this folder
'
'Example: <code>
'Dim m As Message
'm = MailParser.ParseMail("Content-Type: text/plain; charset=" & QUOTE & "utf-8" & QUOTE, File.DirRootExternal)
'Log(m)</code>
The code will be syntax highlighted:
 

margret

Well-Known Member
Licensed User
This is a great addition as always!! Being able to add code samples in the Docs is really awesome!

Thanks Erel
 

pluton

Active Member
Licensed User
Erel you are the greatest

B4A is so simply to use without knowing java programming. Thank you a lot

 

naruto

Member
Licensed User
Will there be a way to automatically extract the documentation written above each function to for example an XML file? This way a help file could easily be made containing all functions which would be cool.

If not, will these function description text above each function be saved into the .java files? If so I guess we could use some kind of documentation tool to extract the comments and create the help file.
 

Erel

Administrator
Staff member
Licensed User
I will consider adding it. Not sure whether it will make it in v2.00.
 

Smee

Well-Known Member
Licensed User
Excellent Feature Erel

Thasnks

Now for

With
..
..
End With

We are never satisfied are we?

:sign0060::sign0060:
 
Top