How to document code (such as JavaDoc?)

[charms]

Hello,

Is there a recommended way to document code such as own handlers? Something similar to JavaDoc so that it is possible to browse and search for handlers?

Thanks,
Chris

[dunbarx]

Hi.

LC has a very powerful and useful search tool. Check out the "Find and Replace" stack in the "Edit" menu. You can search for all kinds of things, in an out of scripts.

Craig Newman

[bn]

Hi Chris,

I don't know what JavaDoc is. I looked it up and it seems to be a way to output your code as pdf?

if you want an overview of all your scripts in a stack look here
http://livecodeshare.runrev.com/stack/5 ... eporter-LC

If you want to mark your scripts e.g. for DEBUG or any other comment then
https://livecode.com/store/marketplace/lcTaskList-1-3/

It lists all your scripts where you made an uppercase comment, some keywords are predefined and you can add your own. And for 10$ it is really a good deal.

Kind Regards
Bernd

[charms]

Hi Bernd,

Thanks for the links. JavaDoc is a standardized way to document functions and classes in Java. When you run JavaDoc it will create browsable HTML pages with all the functions and descriptions. Here is a link that describes it:

http://www.write-technical.com/126581/j ... c-info.htm

It's similar to the dictionary in LiveCode. Just that it also contains the description of your own handlers.

I guess I could write something myself. Should not be too complicated. Just wanted to know if LiveCode has a standard way documenting source already. But I'll give your proposals a shot.

Kind regards,
Chris

[FourthWorld]

https://livecode.com/store/marketplace/nativedoc-3-0-0/

[charms]

Thanks, looks good

[charms]

Well we have actually tested it. First of all the links on the LiveCode webpage didn't work anymore. The site had changed in the meantime. Even though it still looked like it was supported I think the last update was done in 2012. We were able to download a test version. However we didn't get it to work in the evaluation version. And this says everything that has to be said about using such plugins. Outdated, unsupported, not usable, but $49 of course Not a good sign in my eyes.

[charms]

Seems like this stack is outdated.

[jacque]

This actually brings me to the conclusion that Livecode is basically dead. Even though the solution itself is actually very innovative..

I'm confused. A third party developer has stopped upgrading a product, so LiveCode is dead?

[charms]

I think I had too much wine and a bad moment when writing my last entry. I changed it. I apologize for my writing. I'm developing a commercial product with Livecode and am a very happy customer. I think I wanted to write that the plugin is not maintained anymore and therefore dead. Hope it didn't cause any harm.

[bn]

Hi Chris,

why don't you write to Damien?

http://www.nativesoft.net/support/contact/

he is very meticulous programmer. There are chances that he is not aware of the problems you describe.

Kind regards

Bernd

[Simon]

Something changed recently on the liveCode website where all the store try out's links became https. I contacted one vendor about it but never tested them all.

Simon

[charms]

Ok, thanks for your inputs. Currently I'm thinking about an own small solution creating a plugin. But if this results in too much work I'll contact him.

[charms]

Wrote my own one.

http://www.eerraa.com/?page_id=1164

[FredBeck]

This is very cool! Thanks for sharing!
You need to use \ for file path on windows , and for some reason the stack resising is completely off. Apart from that it seems to work fine on LC 7.1 windows.