juneau-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] jamesbognar commented on issue #28: Adding more examples on core module
Date Sat, 08 Dec 2018 21:29:50 GMT
jamesbognar commented on issue #28: Adding more examples on core module
URL: https://github.com/apache/juneau/pull/28#issuecomment-445491395
 
 
   @Akayeshmantha - Thanks for the contribution!  If you're interested in describing your
examples, I recommend adding some information to the following file:
   /juneau-doc/docs/Topics/14.juneau-examples-core/01.Examples.html
   
   These topic files get generated into the Javadoc overview document:
   http://juneau.apache.org/site/apidocs-8.0.0/overview-summary.html#juneau-examples-core
   
   Since it's part of the overview document, you might just provide a link with a one-line
description that takes you to the javadoc for your example:
   http://juneau.apache.org/site/apidocs-8.0.0/org/apache/juneau/examples/core/json/JsonComplexExample.html
   
   Also, you can link to your source code using a {@source} taglet in your class-level javadoc.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message