OraOpenSource / plsql-md-doc

Converts PL/SQL JavaDoc documentation to markdown
MIT License
51 stars 16 forks source link

Add ability to parse .sql files like views #72

Open vitodcampanelli opened 6 years ago

vitodcampanelli commented 6 years ago

I would like to be able to create documentation for views as well. It would be nice if it would be able to get the fields from the select list or the ability to add the fields manually. I tried to use the template package.md for .sql but all that display is the description. I would like to be able to do something like this:

/**
 * View is used for ..........
 *
 * @field field1 maybe ability to description of field
 * @field field2 maybe ability to description of field
 *
 * @author John Doe
 * @created 23-Nov-2017
 */

Thanks

vitodcampanelli commented 6 years ago
/**
 * View is used to see the employee details. 
 *
 * @issue #123
 *
 * @field id the primary key
 * @field start_date the employee's start date
 * @field end_date the employee's end date
 *
 * @author John Doe
 * @created 23-Nov-2017
 */
create or replace view v_table
as
select    id,
          start_date,
          end_date
from table
where ....