New feature: built-in documentation

Erel · Jun 7, 2012

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:

BarrySumpter · Jun 20, 2012

LOL.
Was just wondering how to implement this!
As always, the solution is there, I just have to find it.
Too Easy!
Brilliant!

Thanks Erel.

etLux · Jun 20, 2012

Nice!

I've said it before, but it bears repeating:

B4A is one of the best development software bargains around!

Great product, great price, great support -- and an unparalleled effort to continually improve it.

Best,

David
-----
David Sosnowski

The Music of David Sosnowski
www.DavidSosnowski.com

Roger Garstang · Jun 20, 2012

Renamed a Sub with documentation above it today and the documentation didn't reappear until I modified the comments in some way. Not a big deal, but may want to tweak the parser.

jeeradate · Jul 7, 2012

pluton said:
Erel you are the greatest

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

I am agree with him that Erel is the Great.
:sign0098:

psciga · Aug 8, 2012

Thank you very much Erel!

Watchkido1 · Aug 10, 2012

Great!

Great! :sign0060:

Djembefola · Aug 15, 2012

The built-in documentation is so easy to use: brilliant, Erel!

The only thing i am currently missing: because there is no way to implement public properties as class members, i often have to use public variables (disadvantage: no encapsulation) as a workaround. Unfortunately public variables are excluded from the built-in documentation.

Would it be possible to include comment lines above public variables in the documentation?

Maybe my question is obsolete because you already plan to implement class properties in the next version...

Erel · Aug 16, 2012

There are plans to add support for class properties. Not sure whether it will be included in the next version.

margret · Aug 16, 2012

I love the new auto documentation! I have one question. When I use certian characters in the documentation like, #, >, <, etc. I get an error that says XML is not formatted correctly. I tried to escape the line but no luck. Any help or ideas on this?

B4A Rocks!!!

Thanks,

Margret

Erel · Aug 16, 2012

>, < should be escaped:

B4X:

'for &lt;example&gt; #

escaping - Where can I get a list of the XML document escape characters? - Stack Overflow

margret · Aug 16, 2012

Awesome!! Thanks!

Theera · Sep 18, 2012

Example built-in documentation

Hi all,
Help me to show Example about built-in documentation? I don't know to apply continue.

Best Regards
Theera

klaus · Sep 18, 2012

Have a look at Erels first post everything is shown there.

Best regards.

Theera · Sep 19, 2012

klaus said:
Have a look at Erels first post everything is shown there.

Best regards.

Hi Klaus,
I try understand Erel's post,but I don't see example ,I don't clear.
P.S.I'm not good at both English and Programming,Please understand me.
Best Regards
Theera

Ricky D · Sep 19, 2012

Hi Theera like Klaus said look at Erel's first post.

He has the example there.

Regards, Ricky

Theera · Sep 19, 2012

I'm sorry,please to see my code.

Ricky D said:
Hi Theera like Klaus said look at Erel's first post.

He has the example there.

Regards, Ricky

I'm sorry,I'm really stupid. Please to correct to me. I need to learn more.

Best Regards
Theera

Ricky D · Sep 19, 2012

That's okay mate. You're not stupid either. I'm sure all of us have trouble understanding something or other.

By asking questions shows me you're keen to understand and that's a sign of a hungry mind.

Regards, Ricky

Theera · Sep 20, 2012

No one help me

Theera said:
Hi Klaus,
I try understand Erel's post,but I don't see example ,I don't clear.
P.S.I'm not good at both English and Programming,Please understand me.
Best Regards
Theera

Hi Klaus,
Excuse me,Would like you help me correct my code please? I have no idea to edit my code.
Best Regards
Theera

PaulR · Sep 20, 2012

Here's what you have...

B4X:

Sub btn_Click
   '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)
End Sub
Sub ParseMail(Mail As String,AttachmentDir As String) As message
  index = 0
  multipart = Flase
  boundary =""
  Dim msg As message
  msg.initialize
  msg.Attachments.initialize
End Sub

Hi, you have put the documentation comments inside the btn_click sub. It shouldn't be in any sub. You need to put the documentation comments directly above the Sub declaration you want the documentation for... with no blank lines. You also need to comment ALL lines, including the code.

Finally, you need to put <code> at the beginning of the code example AND </code> at the end of the code example.

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>
Sub ParseMail(Mail As String,AttachmentDir As String) As message
  index = 0
  multipart = Flase
  boundary =""
  Dim msg As message
  msg.initialize
  msg.Attachments.initialize
End Sub

Hope that clears things up....

Theera · Sep 21, 2012

PaulR said:
Here's what you have...

B4X:

Sub btn_Click '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) End Sub Sub ParseMail(Mail As String,AttachmentDir As String) As message index = 0 multipart = Flase boundary ="" Dim msg As message msg.initialize msg.Attachments.initialize End Sub

Hi, you have put the documentation comments inside the btn_click sub. It shouldn't be in any sub. You need to put the documentation comments directly above the Sub declaration you want the documentation for... with no blank lines. You also need to comment ALL lines, including the code.

Finally, you need to put <code> at the beginning of the code example AND </code> at the end of the code example.

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> Sub ParseMail(Mail As String,AttachmentDir As String) As message index = 0 multipart = Flase boundary ="" Dim msg As message msg.initialize msg.Attachments.initialize End Sub

Hope that clears things up....

Hi PaulR,
I 'm sorry for my stupid.I still not clear up.Please give example for me.Because I 'm not good at English too.I understand English only 5-10% .

Best Regards
Theera

New feature: built-in documentation

B4X founder

Active Member

Member

Well-Known Member

Member

Active Member

Active Member

Active Member

B4X founder

Well-Known Member

B4X founder

Well-Known Member

Well-Known Member

Expert

Well-Known Member

Well-Known Member

Well-Known Member

Well-Known Member

Well-Known Member

Active Member

Well-Known Member

Privacy & Transparency

Privacy & Transparency