plsqlDoc is a great plugin!
I am documenting an Oracle/Cold Fusion project as I maintain it. Of course the developers don't waste time formatting their code. I don't know how they can read it. Unless... they purposefully de-format the code before moving to production.
Just kidding.
Personally, I use UltraEdit to insert documentation headers and format the code, so it is readable, add the documentation data and then paste it into PLSQL Developer to compile and generate documentation.
On to why I started this thread in the first place...
Documenting Procedures and Functions I use the #return tag but it would be nice if the #return tag syntax were similar to the #param tag syntax.
I like to list the RETURN v_variable; with the definition. i.e. '#return '
In the final version of the documentation I have to manually change the html, if I catch it,
From:
[TR][TD]
[/TD][TD]
rec_found BOOLEAN Returns TRUE if genarg_table = TIDWOTCC or TIDWOOPS or TIDWOSTR else Returns FALSE
[/TD][/TR]
To:
[TD]
rec_found
I am documenting an Oracle/Cold Fusion project as I maintain it. Of course the developers don't waste time formatting their code. I don't know how they can read it. Unless... they purposefully de-format the code before moving to production.
Just kidding.Personally, I use UltraEdit to insert documentation headers and format the code, so it is readable, add the documentation data and then paste it into PLSQL Developer to compile and generate documentation.
On to why I started this thread in the first place...
Documenting Procedures and Functions I use the #return tag but it would be nice if the #return tag syntax were similar to the #param tag syntax.
I like to list the RETURN v_variable; with the definition. i.e. '#return '
In the final version of the documentation I have to manually change the html, if I catch it,
From:
[TR][TD]
[/TD][TD]
rec_found BOOLEAN Returns TRUE if genarg_table = TIDWOTCC or TIDWOOPS or TIDWOSTR else Returns FALSE
[/TD][/TR]
To:
[TD]
rec_found
