What's not in the documentation?

SQL Doc - 2.0

Versions available: 2.1, 2.0

Learning SQL Doc - 2.0

What's not in the documentation?

For details of what's included in the generated documentation, see What's in the documentation. The following tips contain notes about information that the documentation does not always include.

Extended stored procedures

SQL Doc does not document extended stored procedures.

Encrypted database objects

If you are documenting a SQL Server 2000 database that contains an encrypted user-defined function, stored procedure, trigger, or view and you have system administrator permissions, SQL Doc can decrypt the object and you can view its internal SQL.

SQL Doc does not decrypt views, stored procedures, functions, DML triggers, and DDL triggers that are encrypted in a SQL Server 2008 or SQL Server 2005 database. Therefore, SQL Doc cannot document the SQL creation script for these encrypted objects.

Certificates, symmetric keys, and asymmetric keys

SQL Server severely restricts access to certificates, symmetric keys, and asymmetric keys. Consequently, SQL Doc cannot document all of the properties for these objects.

Replication

SQL Doc does not document stored procedures that have been created for replication.

Numbered stored procedures

SQL Doc documents only one stored procedure for groups of numbered stored procedures.

Object dependencies

Object dependencies are only available in the generated documentation; they are not shown in the preview. This is to enable SQL Doc to display the preview more quickly.

Row count

Row count is only available in the generated documentation; it is not shown in the preview. This is to enable SQL Doc to display the preview more quickly.

SQL Script

By default, the SQL creation script for an object is included in the documentation. You can exclude it by clearing the Include SQL creation script in generated documentation check box on the project configuration dialog box.

Was this article helpful?

Search support