New feature: built-in documentation

Erel

Erel

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

Comments above subs, such as:
SS-2012-06-07_15.30.52.png


Will automatically appear in the pop-up window:
SS-2012-06-07_15.33.24.png




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:
SS-2012-06-07_15.37.42.png
 
Sort by date Sort by votes
Amalkotey

Amalkotey

Active Member
Licensed User
Longtime User
Top!

-Amalkotey-
 
Upvote 0
pluton

pluton

Active Member
Licensed User
Longtime User
Erel you are the greatest

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

Alien124.gif
 
Upvote 0
rbsoft

rbsoft

Active Member
Licensed User
Longtime User
Great feature!

Rolf
 
Upvote 0
N

naruto

Member
Licensed User
Longtime 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.
 
Upvote 0
S

Smee

Well-Known Member
Licensed User
Longtime User
Excellent Feature Erel

Thasnks

Now for

With
..
..
End With

We are never satisfied are we?

:sign0060::sign0060:
 
Upvote 0
You must log in or register to reply here.
Top