search

OraOpenSource / plsql-md-doc

Converts PL/SQL JavaDoc documentation to markdown
MIT License
50 stars 15 forks source link

Support for Oracle Objects #51

Open rlove opened 7 years ago

rlove commented 7 years ago

Just ran this against utPLSQL code that has several Oracle Objects such as:

/** 
 * description
 *    ut_composite_object 
 **/
create or replace type ut_composite_object force under ut_object
(
  items      ut_objects_list,

  member procedure calc_execution_result(self in out nocopy ut_composite_object),
  member function item_index(a_object_name varchar2) return pls_integer,
  member procedure add_item(self in out nocopy ut_composite_object, a_item ut_object)
) not final not instantiable
/

Only a MD file with the filename is produced. This is a feature request to support the oracle object syntax.

martindsouza commented 7 years ago

What do you think the @ name should be? @type is for basic types. Should we call it @object?

jgebal commented 7 years ago

I would use @object @type is more approprate for PLSQL (package level) types

jgebal commented 7 years ago

Quick question. The type/package comments should be inside the code (after the create type/package line) right?

jgebal commented 7 years ago

Also, can we have documentation for type attributes?

martindsouza commented 7 years ago

@jgebal Docs should be inside the package. Usually above the proc/types/constants.

See https://github.com/OraOpenSource/plsql-md-doc/blob/master/docs/javadoc-template.md for template and https://github.com/OraOpenSource/oos-utils/tree/master/source/packages for examples.

@rlove we decided on @type (see above links)