|
| |
|
| anttasks.SitemapTask
| SitemapTask | | final public class SitemapTask extends AbstractQdoxTask (Code) | | Generate documentation for sitemap components based on javadoc tags
in the source of the component.
This is the first, experimental version - the code is a little bit
hacky but straight forward :)
since:
2.1.5
author:
Carsten Ziegeler
version:
CVS $Id: SitemapTask.java 433543 2006-08-22 06:22:54Z crossley $ |
| Inner Class :final class SitemapComponent | |
| CACHING_INFO_TAG | | final public static String CACHING_INFO_TAG(Code) | | Caching info (optional)
|
| CONF_TAG | | final public static String CONF_TAG(Code) | | Configuration (optional)
|
| DOC_TAG | | final public static String DOC_TAG(Code) | | The documentation (optional)
|
| HIDDEN_TAG | | final public static String HIDDEN_TAG(Code) | | If this tag is specified, the component is not added to the sitemap (optional)
|
| LABEL_TAG | | final public static String LABEL_TAG(Code) | | The label for views (optional)
|
| LOGGER_TAG | | final public static String LOGGER_TAG(Code) | | The logger category (optional)
|
| MIMETYPE_TAG | | final public static String MIMETYPE_TAG(Code) | | The mime type for serializers and readers (optional)
|
| NAME_TAG | | final public static String NAME_TAG(Code) | | The name of the component in the sitemap (required)
|
| NO_DOC_TAG | | final public static String NO_DOC_TAG(Code) | | If this tag is specified no documentation is generated (optional)
|
| POOL_MAX_TAG | | final public static String POOL_MAX_TAG(Code) | | Pooling max (optional)
|
| blockName | | protected String blockName(Code) | | The name of the block
|
| deprecated | | protected boolean deprecated(Code) | | Is this block deprecated?
|
| stable | | protected boolean stable(Code) | | Is this block stable?
|
| capitalize | | public static String capitalize(String str)(Code) | | Helper method to capitalize a string.
This is taken from commons-lang, but we don't want the dependency
right now!
|
| execute | | public void execute() throws BuildException(Code) | | Execute generator task.
throws:
BuildException - if there was a problem collecting the info |
| setBlock | | public void setBlock(String value)(Code) | | Set the block name
|
| setDeprecated | | public void setDeprecated(boolean value)(Code) | | Is the block deprecated?
|
| setDocDir | | public void setDocDir(File dir)(Code) | | The location of the documentation files
|
| setSitemap | | public void setSitemap(File sitemap)(Code) | | The location of the sitemap
|
| setSource | | public void setSource(File dir)(Code) | | Set the directory containing the source files.
Only .java files will be scanned
|
| setStable | | public void setStable(boolean value)(Code) | | Is the block stable?
|
|
|
|