Introduction

Creates javadoc-style HTML documentation for database schema objects or/and user defined objects.

DbDoc web application.
DbDocCmd command line application (see, http://dbdocs.googlecode.com/svn/trunk/DbDocCmd/dbdoccmd_doc_example.zip'>example).

https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=T8PSGE58F34MC&lc=CZ&item_number=dbdocs&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted'>https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif' />

Usage

Create properties file similar to http://code.google.com/p/dbdocs/source/browse/trunk/DbDoc/res/props/oracle_sample.properties'>oracle_sample.properties and start application using properties file name.

If owner differs form login user, http://code.google.com/p/dbdocs/source/browse/trunk/DbDoc/res/sql/oracle_all.sql'>oracle_all.sql file should be used and owner specified in properties file.

Implemented databases

• Oracle
  Note: to implement other databases, I hope, it is only needed to create SQL file similar to
  oracle.sql

Implemented following schema objects

• function
  
• package
  
• procedure
  
• queue
  
• scheduler
  
• sequence
  
• table
  
• trigger
  
• type

Rules to document packages

• Default mode
  
  1. Comments between slash and two asterisks ( /** ) and an asterisk and a slash ( */ ) treated as documentation.
     
• AllCommentsAsDoc mode
  
  1. All comments treated as documentation ( Comments between slash and an asterisk and comments that begin with -- (two hyphens) ).
     
  2. Empty line commented with two hyphens separates documentation blocks.

Project http://code.google.com/p/tapig/'>Table API Generator for Oracle has http://code.google.com/p/tapig/source/browse/trunk/examples/generated_tapi_spec.sql'>example of documented package.

User defined objects

User defined objects (UDO) are the tables, data from which should be documented. It can be application constants, settings, etc.
To create UDO it is needed to change SQL file and add new object to properties file (see example below) and screenshots.

SQL file

-- OBJECTS add AND (...) to filter rows


OBJECTS==SELECT object_name FROM (


SELECT object_name


FROM user_objects


WHERE ( object_name NOT LIKE '%$%' AND object_name NOT LIKE '%#%' )


  AND object_type = :type


  #NAME#


UNION


SELECT 'APUSERS' object_name FROM DUAL


)


ORDER BY object_name


-- APUSERS


APUSERS==SELECT *


FROM APUSERS


ORDER BY id


...

Properties file

Objects          = FUNCTION,PACKAGE,PROCEDURE,QUEUE,SCHEDULER,SEQUENCE,TABLE,TRIGGER,TYPE,APUSERS