Plsqldoc and object types

[stfkbf]

I am not sure if this is the right forum to post this in as it is related to a plugin, anyway:

When documenting overriding member functions on object types:

-- Returns the object type as a varchar2.
-- #return The object type as varchar2.
OVERRIDING MEMBER FUNCTION get_type

Plsqldoc generates documentation that looks like this:

Attributes
OVERRIDING Returns the object ...

It seems the plugin is not able to handle the overriding keyword. Is there any way to configure this ?

I am currently using Pl/Sql developer 6.0.4.

Also it would be nice if the documentation automatically could insert a link to the super class when generating documentation for subtypes.

Best
Thorbj

 

[Marco Kalter]

This seems to be a bug. We'll fix it. If you need a pre-release, let me know.

 

[stfkbf]

Thanks for the quick reply.

When is the next release expected (alternatively is there a published release schedule available) ?

Best,
Thorbj

 

[Marco Kalter]

We don't have a date for 6.0.5 yet, but it will probably be available within 2 or 3 weeks.

 

[stfkbf]

I'll wait for release 6.0.5 then.

Thanks
Thorbj

 

[stfkbf]

The problem does not seem to be fixed in version 6.0.5 ?

 

[Marco Kalter]

Sorry, my mistake, it's really a plsqldoc Plug-In issue. I can send you a fix if you want.

 

[stfkbf]

That would be nice thank you

 

[Marco Kalter]

Okay, I will send you something shortly.

 

[stfkbf]

The problem with documenting object types does not seem to be fixed in the new beta version of plsqldoc either.

Regards
Thorbj

 

[William Robertson]

You can install it? I just get "Installation failed" when I run setup.exe (PL/SQL Dev 6.0.5.926, MS Windows XP 6.0 Service Pack 2, existing plsqldoc 1.1.6).

 

[Marco Kalter]

The problem with documenting object types does not seem to be fixed in the new beta version of plsqldoc either.

I was under the impression that this was fixed. I will check it out.

I just get "Installation failed" when I run setup.exe

Perhaps PL/SQL Developer is running when you run setup? Of so, exit PL/SQL Developer and try again.

 

[stfkbf]

I had no problems installing (with Pl/SQL developer closed) using the following version:

PL/SQL Developer
Version 6.0.5.926 (MBCS)
01.17670 - 20 user license
Windows XP version 6,0 (build 2600) Service Pack 2

also with version 1.1.6 installed.

Regards Thorbj

 

[Marco Kalter]

Can you send me the complete type source file with the overriding member function? I cannot reproduce the issue.

 

[stfkbf]

The following example illustrates the problem with ver. 1.1.6. Version 1.2beta does not seem capable of generating documentation for object types:

CREATE OR REPLACE TYPE parent_type AS OBJECT
(
-- Author : TBF
-- Created : 26-04-2005 08:05:54
-- Purpose :

attr1 NUMBER,

MEMBER PROCEDURE test_proc(SELF IN OUT parent_type,
io_param IN OUT NUMBER)
)
NOT FINAL
/
CREATE OR REPLACE TYPE BODY parent_type IS

-- Member procedures and functions
MEMBER PROCEDURE test_proc(SELF IN OUT parent_type,
io_param IN OUT NUMBER) IS
BEGIN
NULL;
END;

END;
/

CREATE OR REPLACE TYPE child_type UNDER parent_type
(
-- Author : TBF
-- Created : 26-04-2005 08:10:28
-- Purpose :

-- Member functions and procedures
OVERRIDING MEMBER PROCEDURE test_proc(SELF IN OUT child_type,
io_param IN OUT NUMBER),

MEMBER PROCEDURE test_proc2(SELF IN OUT child_type,
io_param IN OUT NUMBER)
)
/
CREATE OR REPLACE TYPE BODY child_type IS

-- Member procedures and functions
OVERRIDING MEMBER PROCEDURE test_proc(SELF IN OUT child_type,
io_param IN OUT NUMBER) IS
BEGIN
NULL;
END;

MEMBER PROCEDURE test_proc2(SELF IN OUT child_type,
io_param IN OUT NUMBER) IS
BEGIN
NULL;
END;
END;
/

 

[Marco Kalter]

Okay, thanks. Apparently there is a problem with the type specification. The type body works okay. we'll fix it.

 

[stfkbf]

The beta you sent fixes the problem.

Thank you for looking into it

Regards
Thorbj