1. Dan Cooperstock
  2. PowerBuilder
  3. Tuesday, 13 June 2023 20:53 PM UTC

Following an earlier thread where I was searching for an application to document my PBLs in a HTML website, by extracting comments etc. from my code, I ended up writing something, which I have attached, and offer for free for anyone's use.

It can document a single PBL, or all of the PBLs in a target (PBT).

It's not a completely standalone solution, as it requires the installation and use of the generic documentation generator NaturalDocs (www.naturaldocs.org). 

What's in the Zip file is a PB 2021 workspace, target and PBL with my application in it, configuration files for NaturalDocs, and a fairly comprehensive Help file explaining the required setup and usage.

The generated documentation can be improved by writing your comments at the start of functions, events etc. in the style it expects, and for objects that don't contain code, supplying a Comment in the object's Properties. It's all explained in the Help.

I'm sure this doesn't do anywhere near as good a job as VisualExpert (https://www.visual-expert.com/) but it's free! It was good enough for my purposes, which was helping a new PB hire to understand the common library used in our applications.

Attachments (1)
John Fauss Accepted Answer Pending Moderation
  1. Tuesday, 13 June 2023 21:34 PM UTC
  2. PowerBuilder
  3. # 1

Thank you, Dan! I appreciate you sharing this with the Community.

Please consider posting your app in CodeXchange? It's just the sort of handy utility that needs to reside there.

Comment
  1. Armeen Mazda @Appeon
  2. Tuesday, 13 June 2023 22:03 PM UTC
Totally agree, this should be in CodeXchange
  1. Helpful
  1. Dan Cooperstock
  2. Tuesday, 13 June 2023 22:20 PM UTC
Done, thanks for the suggestion. I have mostly only used the Q&A here so I didn't think of it!
  1. Helpful 3
  1. Armeen Mazda @Appeon
  2. Wednesday, 14 June 2023 02:01 AM UTC
No problem.
  1. Helpful
There are no comments made yet.
Chris Pollach @Appeon Accepted Answer Pending Moderation
  1. Wednesday, 14 June 2023 13:21 PM UTC
  2. PowerBuilder
  3. # 2

Hi Dan;

  You make a great point ... "The generated documentation can be improved by writing your comments at the start of functions, events etc. in the style it expects, and for objects that don't contain code, supplying a Comment in the object's Properties."

   May I compliment that with a free PB App code "Commenter" utility ... http://chrispollach.blogspot.com/2023/03/commenter.html

Regards ... Chris   ;-)

Comment
  1. Dan Cooperstock
  2. Wednesday, 14 June 2023 13:53 PM UTC
That does seem helpful, Chris, but I can't figure out from the blog where to find the download for the commenter! There doesn't seem to be a link to it anywhere. It mentions SourceForge but no link, and I didn't find a link on the Software Tool & Die website http://www.softdie.net/ either!
  1. Helpful
  1. Chris Pollach @Appeon
  2. Wednesday, 14 June 2023 14:10 PM UTC
Hi Dan;

Just follow the HERE link in the article ... "You can download the new STD Script Commenter application from the STD Framework's SourceForge project's website by clicking here " ;-)

Regards ... Chris
  1. Helpful
There are no comments made yet.
Chris Pollach @Appeon Accepted Answer Pending Moderation
  1. Tuesday, 13 June 2023 20:57 PM UTC
  2. PowerBuilder
  3. # 3

Awesome .. thanks Dan!

Comment
There are no comments made yet.
  • Page :
  • 1


There are no replies made for this question yet.
However, you are not allowed to reply to this question.