This discussion is archived
8 Replies Latest reply: Aug 27, 2013 10:59 PM by Greg Block RSS

PLDoc problem

Greg Block Newbie
Currently Being Moderated

Hi.

I'm using PLDoc successfully when using the return tag and initial description. However, using the @param tag for a standalone database function does not result in the expected output.
ie:

 

create or replace

FUNCTION

RESP_GET_RSUP_START(

  p_person_id IN NUMBER)

/**<br/>

* Get Research Supervision Start Date.

* <br/>

* This function will return the Date.

*

* @param p_person_id The person ID

* @return The start date of the research supervision.

*/

RETURN DATE IS

 

BEGIN -- main routine.

    NULL;

END resp_get_rsup_start;

/

 

 

Using the above, everything comes out as I expect except the
      * @param p_person_id The person ID

is basically ignored, ie: it doesn't result in the Parameters: section.
I've noticed the example .sql files for the PLDoc software are all using database packages, which I can replicate successfully with my own packages.

I'd like to use the tags for standalone procedures and functions (ie: not in packages). Am I using the tag incorrectly?

Any ideas what I'm doing wrong?

  • 1. Re: PLDoc problem
    user13430807 Explorer
    Currently Being Moderated

    Hello,

     

    I copied your source in my database and this is the result:

    RESP_GET_RSUP_START

              RESP_GET_RSUP_START( p_person_id IN NUMBER ) RETURN DATE 
                Get Research Supervision Start Date.
               This function will return the Date.

    Parameters: 

    p_person_id - The person ID 
    Returns: 
    The start date of the research supervision.

     

    Im my opinion this looks ok.

    I am using the 4.0 version. What version are you using?

     

    Joop

  • 2. Re: PLDoc problem
    Greg Block Newbie
    Currently Being Moderated

    Hi Joop.

     

    That output is exactly what I am looking for.

    However, when I run the software, I get the same result except for the:

    Parameters: 

    p_person_id - The person ID 

    section.

    I am using version 1.3.3 from the source forge project site.

    The latest I can see there is 1.5.6 which also had the same (incorrect) result for me.

    Where did you locate the 4.0 version?

     

    Greg

  • 3. Re: PLDoc problem
    user13430807 Explorer
    Currently Being Moderated

    Hello Greg,

     

    I am using SQL Developer to generate this. You can download this from

    http://www.oracle.com/technetwork/developer-tools/sql-developer/downloads/index.html

     

    I thought you were using SQL Developer too since you posted on this forum.'

     

    Joop

  • 4. Re: PLDoc problem
    Greg Block Newbie
    Currently Being Moderated

    Hi Joop.

     

    No I'm, actually using the PLDoc software as described in the opening post (to work with database functions and procedures written using SQL Developer).

    Previous searches of this area of the forum has located other PLDoc threads so thought this was an appropriate area.

     

    I have a requirement to use PLDoc so any help as to the issue I'm facing would be great.

     

    Regards,

    Greg.

  • 5. Re: PLDoc problem
    Greg Block Newbie
    Currently Being Moderated

    Hi Joop.

     

    You've got me thinking now of swapping to use SQL Developer instead of the PLDoc software.

    How did you generate the output listed above?

    My own search of the functions within SQL Developer hasn't had much success.

     

    Regards,

    Greg.

  • 6. Re: PLDoc problem
    user13430807 Explorer
    Currently Being Moderated

    Hello Greg,

     

    you can generate the pldoc in SQL Developer in the following way:

    - in the connections view connect to a database

    - then on this connection icon, right mouse click and select 'Generate DB Doc'

    - select output directory and the types of object to generate the documentation for

    - and go!

     

    In addition to the pldoc get other info too, like dependencies and references.

     

    Joop

  • 7. Re: PLDoc problem
    Greg Block Newbie
    Currently Being Moderated

    Hi Joop.

     

    Thanks for getting back to me.  I did find that option however it will generate the output for all items in the schema for the types you select (all packages, procedures, etc...).

    If it could allow specific objects within each type to be generated that would be great (as the requirement I'm working towards doesn't want every object).

     

    PLDoc can do what I want; just need to find a way to let it work with the @param tag for procedures, functions.

     

    Regards,

    Greg.

  • 8. Re: PLDoc problem
    user13430807 Explorer
    Currently Being Moderated

    DB Doc generates for all objects, you can't change that. Maybe you can copy the files of the required objects from the html tree being generated.

     

    For PlDoc you have to find another forum. This forum is for SQL Developer.

     

    Joop

Legend

  • Correct Answers - 10 points
  • Helpful Answers - 5 points