search

gboersma / uml-java-doclet

Doclet to generate UML diagrams for Javadoc using PlantUML.
74 stars 29 forks source link

Added retrieval of path to generated javadoc #1

Closed hderuiter closed 7 years ago

hderuiter commented 7 years ago

Dear Mr. Boersma,

First of all let me explain my appreciation for your project. Some time ago I was experimenting with plant UML to generate diagrams for incorporation with javadoc but your doclet does it all!! I was truly amazed! Thank you so much!

When using your doclet with ant it turns out that it could not find the generated javadoc directory. Therefore I wrote a small enhancement so that this directory could be retrieved from a RootDoc option (argument). I also added a goal to pom.xml for generating a jar with dependencies which is convenient for usage with ant (Netbeans IDE permits to substitute the standard doclet by means of additional arguments which can point to a jar).

Please take a look and I hope you find my changes beneficial.

Kind regards,

Henri de Ruiter

gboersma commented 7 years ago

Glad to hear it, Henri. Thanks for the pull request. I'll take a look at it later this week. Feel free to contribute more; much appreciated!

Cheers, Gerald

On Sat, Nov 12, 2016 at 2:47 PM hderuiter notifications@github.com wrote:

Dear Mr. Boersma,

First of all let me explain my appreciation for your project. Some time ago I was experimenting with plant UML to generate diagrams for incorporation with javadoc but your doclet does it all!! I was truly amazed! Thank you so much!

When using your doclet with ant it turns out that it could not find the generated javadoc directory. Therefore I wrote a small enhancement so that this directory could be retrieved from a RootDoc option (argument). I also added a goal to pom.xml for generating a jar with dependencies which is convenient for usage with ant (Netbeans IDE permits to substitute the standard doclet by means of additional arguments which can point to a jar).

Please take a look and I hope you find my changes beneficial.

Kind regards,

Henri de Ruiter

You can view, comment on, or merge this pull request online at:

https://github.com/gboersma/uml-java-doclet/pull/1 Commit Summary

  • - updated pom.xml with a "build jar with dependencies" goal
  • - updated UmlJavaDoclet.java for usage with ant (retrieve javadoc path from root doc)

File Changes

Patch Links:

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/gboersma/uml-java-doclet/pull/1, or mute the thread https://github.com/notifications/unsubscribe-auth/AKXbx1EtF7knpBOyYkn2Hb1e-1Z2HWOIks5q9hfpgaJpZM4KwgkW .

hderuiter commented 7 years ago

Dear Mr. Boersma,

I'm glad to find out that my contributions were merged. In fact this is my first open source contribution ever!

With respect to possible future doclet features, I'm thinking of adding support for Asciidoc based package-info files. During my graduation (not finished yet) I was experimenting with asciidoclet but I find it of little usage for documenting classes and methods. This is due to the fact that my IDE (Netbeans) auto-completion function only shows html based (retrieved from source code, not yet generated) javadoc properly. For package-info files however using Asciidoc could be beneficial. So if find some free time I will take a look at it.

Kind regards,

Henri