Skip to Main Content
IBM Power Ideas Portal


This portal is to open public enhancement requests against IBM Power Systems products, including IBM i. To view all of your ideas submitted to IBM, create and manage groups of Ideas, or create an idea explicitly set to be either visible by all (public) or visible only to you and IBM (private), use the IBM Unified Ideas Portal (https://ideas.ibm.com).


Shape the future of IBM!

We invite you to shape the future of IBM, including product roadmaps, by submitting ideas that matter to you the most. Here's how it works:

Search existing ideas

Start by searching and reviewing ideas and requests to enhance a product or service. Take a look at ideas others have posted, and add a comment, vote, or subscribe to updates on them if they matter to you. If you can't find what you are looking for,

Post your ideas
  1. Post an idea.

  2. Get feedback from the IBM team and other customers to refine your idea.

  3. Follow the idea through the IBM Ideas process.


Specific links you will want to bookmark for future use

Welcome to the IBM Ideas Portal (https://www.ibm.com/ideas) - Use this site to find out additional information and details about the IBM Ideas process and statuses.

IBM Unified Ideas Portal (https://ideas.ibm.com) - Use this site to view all of your ideas, create new ideas for any IBM product, or search for ideas across all of IBM.

ideasibm@us.ibm.com - Use this email to suggest enhancements to the Ideas process or request help from IBM for submitting your Ideas.

Status Not under consideration
Workspace IBM i
Created by Guest
Created on Oct 6, 2016

Implement RPG/CL Documentation Generation within RDi

Currently RPG and CL do not offer a common way for a developer to put comments/documentation within the code and then have documentation be generated.

This is something that other languages offer, such as JAVADocs.

I would like RDi to be able to use the information it already gathers about the code, in the outline view as well as comments added in the code, and generate usable documentation like JAVADocs does.

This would resolve a problem that has been present in the RPG/CL realm for a long time and would simplify the often neglected task of creating system/program documentation.

Other "modern" programming languages have had this ability for a number of years. I really enjoy RPG and want to see it maintain its relevance in todays world and believe that by implementing something like this it will help maintain its relevance and continue to attract younger developers to the language.


Use Case:

Currently there are 2 open source RPG documentation frameworks floating round. RPGLEDOC and ILEDoc. Neither of these are a complete solution and one is no longer maintained at all and the other hasn't been touched in over a year.

By using the lexing and parsing already built into RDi to generate the Outline View, it would not be a long stretch to also gather comments, marked with specific indications, that they should be gathered for the creation of the documentation.

The output of the documentation could be HTML pages or XML that could then be used to generate documentation in ones desired format.

Fixed Format, Free Format and Fully Free Format should all be able to generate the the documentation.


Idea priority High
  • Guest
    Reply
    |
    Oct 13, 2016

    This RFE is a duplicate of another RFE. See RFE25264 for current status.

  • Guest
    Reply
    |
    Oct 6, 2016

    Also created a LUG requirement. LUG Requirement # XX1473