Hi,
I want to document files containing the specification for views (each file contains a view) but I can't find documentation showing how can I do it and I can't seem to make it work.
I'm doing something like this:
I would not use PLDoc for documenting tables or views: simply because there are better tools to document these objects. The PLDoc code to work on these objects has not been worked on for a very long time.
I use SchemaSpy, more usually via the Maven plugin maven-schemaspy-plugin(this version extends the one in SourceForge - https://github.com/wakaleo/maven-schemaspy-plugin: that way I combine the strengths of PLDoc (parsing PL/SQL), with the strengths of SchemaSpy (database agnostics, with referential constraint.
The only problem with this version of the SchemaSpy plugin is that it requires generating locally before use (git clone .... && mvn clean install) as only an old version exists in Maven Central.
I have just noticed that Maven Central (http://search.maven.org/) now contains usable versions of the SchemaSpy plugin
Use this [fork] (https://github.com/sturton/maven-schemaspy-plugin) if you want the Schema Spy plugin to work with:-
multiple schemas
unusual table or column names (names which require HTML encoding or table names which contain the dollar/$ sign)
TimesTen databases
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hi,
I want to document files containing the specification for views (each file contains a view) but I can't find documentation showing how can I do it and I can't seem to make it work.
I'm doing something like this:
CREATE OR REPLACE VIEW
/
* View description.
* @param column1 description
* @param column2 description
* @param column3 description
*/
test_view (
column1,
column2,
column3
) AS
SELECT
column1,
column2,
column3
FROM atable;
/
The comments are not read by PLDoc, despite the view and their columns showing in the documentation generated by PLDoc.
I would not use PLDoc for documenting tables or views: simply because there are better tools to document these objects. The PLDoc code to work on these objects has not been worked on for a very long time.
I use SchemaSpy, more usually via the Maven plugin maven-schemaspy-plugin(this version extends the one in SourceForge - https://github.com/wakaleo/maven-schemaspy-plugin: that way I combine the strengths of PLDoc (parsing PL/SQL), with the strengths of SchemaSpy (database agnostics, with referential constraint.
The only problem with this version of the SchemaSpy plugin is that it requires generating locally before use (git clone .... && mvn clean install) as only an old version exists in Maven Central.
I have just noticed that Maven Central (http://search.maven.org/) now contains usable versions of the SchemaSpy plugin
Use this [fork] (https://github.com/sturton/maven-schemaspy-plugin) if you want the Schema Spy plugin to work with:-
multiple schemas
unusual table or column names (names which require HTML encoding or table names which contain the dollar/$ sign)
TimesTen databases