db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Rick Hillegas (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DERBY-6980) Documentation changes to accompany jigsaw-modularization of derby
Date Wed, 17 Oct 2018 18:17:00 GMT

    [ https://issues.apache.org/jira/browse/DERBY-6980?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16653983#comment-16653983
] 

Rick Hillegas commented on DERBY-6980:
--------------------------------------

Attaching derby-6980-01-aa-moduleDiagramsInJavadoc.diff. This patch adds module diagrams to
the javadoc. The patch makes the following changes:

1) Adds module diagrams. The diagrams are written in human-readable SVG markup.

2) Updates the stale landing page for the public API.

3) Adds header comments to the module descriptors. The header comments end up on the landing
pages for the module javadoc. The header comments display the module diagrams.

Just to be safe, I will run the full tests.


Touches the following files:

{noformat}
----------------------------

A       tools/javadoc/moduleDiagrams
A       tools/javadoc/moduleDiagrams/client.svg
A       tools/javadoc/moduleDiagrams/commons.svg
A       tools/javadoc/moduleDiagrams/engine.svg
A       tools/javadoc/moduleDiagrams/optionaltools.svg
A       tools/javadoc/moduleDiagrams/runner.svg
A       tools/javadoc/moduleDiagrams/server.svg
A       tools/javadoc/moduleDiagrams/tests.svg
A       tools/javadoc/moduleDiagrams/tools.svg

Add module diagrams.

----------------------------

M       java/org.apache.derby.client/module-info.java
M       java/org.apache.derby.commons/module-info.java
M       java/org.apache.derby.engine/module-info.java
M       java/org.apache.derby.optionaltools/module-info.java
M       java/org.apache.derby.runner/module-info.java
M       java/org.apache.derby.server/module-info.java
M       java/org.apache.derby.tests/module-info.java
M       java/org.apache.derby.tools/module-info.java

Add header comments to the module descriptors. The header comments
appear on the javadoc landing pages for the modules.

----------------------------

M       build.xml

Copy the module diagrams into the javadoc output.

----------------------------

M       published_api_overview.html

Update the stale landing page for the public API.
noformat}


> Documentation changes to accompany jigsaw-modularization of derby
> -----------------------------------------------------------------
>
>                 Key: DERBY-6980
>                 URL: https://issues.apache.org/jira/browse/DERBY-6980
>             Project: Derby
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 10.15.0.0
>            Reporter: Rick Hillegas
>            Assignee: Rick Hillegas
>            Priority: Major
>         Attachments: derby-6980-01-aa-moduleDiagramsInJavadoc.diff
>
>
> This is a place to collect the documentation changes which must be made as a result of
the work on DERBY-6945.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message