Documentation for package level comments

barsema · Jul 19, 2017 · 803ca5e · 803ca5e
1 parent 5b01f32
commit 803ca5e
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/docs/javadoc.md b/docs/javadoc.md
@@ -12,6 +12,7 @@ This document outlines all the JavaDoc options for PL/SQL as well as examples on
   - [`@param`](#tag-param)
   - [`@private`](#tag-private)
   - [`@return`](#tag-return)
+- [Package Level Comments](#package-level)s
 - [`@constant`](#constants)s
 - [`@type`](#types)s
 
@@ -266,6 +267,29 @@ p_user_id |
 *return* | User first name
 ```
 
+## Package Level Comments<a name="package-level"</a>
+Packages may contain JavaDoc comments as well. The following is an example of package level documentation:
+
+```plsql
+/**
+ * Some package level comments
+ * Another line
+ * @author Martin D'Souza
+ * @created 18-Jul-2017
+ */
+create or replace package body oos_util_apex
+...
+```
+
+```markdown
+{{#if global}}
+## Package Description
+{{#if global.author}}Author: {{global.author}} {{/if}}
+{{#if global.created}}Created: {{global.created}} {{/if}}
+{{{global.description.full}}}
+{{/if}}
+```
+
 ## `@constant`s<a name="constants"></a>
 
 Constants should be placed at the top of the package. There should only be one JavaDoc documentation area for constants. Constants are documented using the `@constant` tag and use the notation: `@constant <constant name> <optional description>`.

diff --git a/templates/package.md b/templates/package.md
@@ -1,5 +1,10 @@
 # {{toUpperCase name}}
 
+{{#if global}}
+## Package Description
+{{{global.description.full}}}
+{{/if}}
+
 {{#if types}}
 - [Data Types](#types)
 {{/if}}