Package conary :: Package build :: Module build :: Class JavaDoc

Class JavaDoc

  action.Action --+                
                  |                
action.RecipeAction --+            
                      |            
            BuildAction --+        
                          |        
                _FileAction --+    
                              |    
                            Doc --+
                                  |
                                 JavaDoc

NAME

r.JavaDoc() - Installs documentation files

SYNOPSIS

r.JavaDoc(filename, [dir=/path])

DESCRIPTION

The r.JavaDoc() class is called from within a Conary recipe to Install documentation files from the %(builddir)s into %(destdir)s/%(thisjavadocdir)s.

Specify a single file or directory of files for the filename parameter. The dir=path keyword argument can be used to create a subdirectory of %(destdir)s/%(thisjavadocdir)s where files may subsequently be located.

KEYWORDS

The r.JavaDoc() class accepts the following keywords:

dir : Specify a subdirectory to create before placing documentation files into it.

package : (None) If set, must be a string that specifies the package (package='packagename'), component (package=':componentname'), or package and component (package='packagename:componentname') in which to place the files added while executing this command. Previously-specified PackageSpec or ComponentSpec lines will override the package specification, since all package and component specifications are considered in strict order as provided by the recipe.