Products         Customers         News         Downloads         Licensing         Shop    

 DocFlex Technology
Overview
Features
Documentation
 DocFlex/XML
Overview
Features
Documentation
XSDDoc
WSDLDoc
Integrations
Bundles
 DocFlex/Javadoc
Overview
Documentation
Basic Templates
JavadocPro
Examples
Tutorials
 DocFlex/Together
Overview
Examples
Basic Templates
Documentation
Tutorials
 Try
Downloads
Registration
Trial License
 Buy
Licensing
Shop
 Company
News
Products
Customers
About Us
Imprint
Legal
Contact
Links
 

DocFlex/Javadoc - Tutorials

Tutorial 1:  Creating a very simple template

This tutorial shows how to create a template which generates a very simple doc -- just the listing of classes specified on the Javadoc command line to document. This includes:
  1. Classes directly specified on the Javadoc command line
  2. Classes contaned in the packages specified on the command line
  3. Classes contained in other classes (inner classes)

View online

Download

flash time 4:54

flash archive (.zip) zip 0.5 Mb

Tutotial 2:  Grouping methods by tags

We have received from our customer the following email:

Hi,

I'd like to use tags to group methods.

For example we'd like to produce the standard javadoc documentation where
there is also a link to an additional page. This additional page should
contain methods which are grouped together by own tags.

My own tags are like the following:

classA {
 /**
  * @ADMIN
  */
  public method1(){};

 /**
  * @USER
  */
  public method2(){};
}

I have classes in different packages and the methods in the classes can have
different tags.

Method1 in packageOne.classA has the tag @ADMIN 
Method2 in packageOne.classA has the tag @USER
Method1 in packageTwo.classA has the tag @USER
Method2 in packageTwo.classB has the tag @ADMIN

The javadoc documentation should then contain something like:

ADMIN methods:
        packageOne.classA Method1
        packageTwo.classB Method2

USER methods:
        packageOne.classA Method2
        packageTwo.classA Method1
...

Here is how that task can be solved with a template:

View online

Download

flash time 5 min

flash archive (.zip) zip 0.8 Mb

The zip archive includes both the Flash/HTML viewlet and the 'methods_by_tags.tpl' template (explained in it).

More Tutorials

Although, at the moment, we cannot prepare the full tutorial course, it's very much possible to highlight some specific topics interesting to the users. Please, do not hesitate to send us your questions to: contact@filigris.com or support@docflex.com

You can also look at DocFlex/XML | Tutorials. This is not about Javadoc. However, all basic ideas are the same!

Copyright© 2003-2014 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.