• You are here:  
  • Home
  • Q&A
  • Q&A
  • PowerBuilder
  • Code / Object Documentation Generator (like JavaDoc)

Subscribe via RSS
Toggle Submenu
  1. Categories
  2. Recent
  3. Tags
View Replies (2)

Resolved Code / Object Documentation Generator (like JavaDoc)

  1. How-to
0
Votes
Undo
  1. Dan Cooperstock
    Dan Cooperstock
  2. PowerBuilder
  3. Thursday, 8 June 2023 18:12 PM UTC

I'm wondering whether anyone knows of or has developed any tools for scanning your libraries and generating nicely formatted HTML docs, based on standard formatting of comments (like JavaDoc does).

I searched and found PBDoc from PBDR, but I'm not sure it really works with current releases. (I tried installing it, it was missing atl71.dll, but I found that elsewhere. But when I got it seeming configured to work on a PBL, it gave a nonsensical error message after working through the objects.)

There's also Visual Expert, but it seems to do so much more and is rather expensive.

I realize I could try writing something myself but it's a moderately large job. Getting the source code of all objects seems fairly easy, but then the big jobs are parsing it for the desired info, and generating nice HTML docs.

BTW the reason for this would be to help a new person learn our objects & code (especially a shared library), especially if I wasn't available.

Thanks.

  1. Documentation
  2. PowerBuilder (Appeon)
  3. Source Code
Temp Directory pbcefdownload not being Cleaned Up
Dynamically change New page on group break datawin...
Responses (2)
Chris Pollach @Appeon
Chris Pollach @Appeon Accepted Answer Pending Moderation
  1. Thursday, 8 June 2023 19:23 PM UTC
  2. PowerBuilder
  3. # 1

Hi Dan;

  How about just using the LibraryDirectory command?

https://docs.appeon.com/pb2022/powerscript_reference/libraryDirectory_func.html

  Then transfer that information into a DataWindow. Then publish that as HTML using the HTML DW feature.

Food for thought.  ;-)

Regards ... Chris

Comment
Dan Cooperstock
  1. Dan Cooperstock
  2. Thursday, 8 June 2023 20:18 PM UTC
I want much more than that Chris. I want the comments for each event and function in objects and windows, I want lists of parameters to functions and their types (augmented by descriptions of each parameter from appropriately styled comments) etc. etc. Like JavaDocs.

Here's an example JavaDoc: https://docs.oracle.com/javase/8/docs/api/java/util/List.html

Here's an example from PBDoc: https://pbdr.com/software/pbdocex/skyblue/index.htm
  1. Helpful
Chris Pollach @Appeon
  1. Chris Pollach @Appeon
  2. Thursday, 8 June 2023 20:50 PM UTC
Hi Dan;

Yes, VisualExpert would be more like JavaDoc. Here is an example of VE's automated documentation on my STD framework ...

https://sourceforge.net/projects/stdfndclass/files/FrameWork/Integrated/Documentation

The PBDOC one is also a good "basic" one too.

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

I actually developed something for this (fun job!) and am offering it for free use. It's in the thread https://community.appeon.com/index.php/qna/q-a/free-generator-of-html-documentation-from-pbls here. 

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.