| | |
- IASApiDocs.DocGenerator.DocGenerator(builtins.object)
-
- JavadocBuilder
class JavadocBuilder(IASApiDocs.DocGenerator.DocGenerator) |
| |
JavadocBuilder(srcFolder, dstFolder, includeTestFolder=False, outFile=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)
Objects from this class generates the javadoc documentation of IAS sources
|
| |
- Method resolution order:
- JavadocBuilder
- IASApiDocs.DocGenerator.DocGenerator
- builtins.object
Methods defined here:
- __init__(self, srcFolder, dstFolder, includeTestFolder=False, outFile=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)
- Constructor
@param srcFolder: the folder with java sources to generate their documentation
@param dstFolder: destination folder for javadocs
@param includeTestFolder: True if the class must generate documentation for the java
sources in test folders (defaults to False)
@param outFile: the file where the output generated by calling javadoc must be sent
- buildJavadocCmd(self, dest, srcFolders, pkgs)
- Build the command to invoke javadoc with subprocess.call.
javadoc must be invoked with a command line like
javadoc -d ./html -splitIndex -windowtitle 'IAS 1.0' -J-Xmx180m -sourcepath ./src -subpackages org:com
@param dest The destination folder where javadoc creates html
@param srcFolders The folders containing java sources
@param pkgs The package roots (org, com, cern..)
@return: a list of parameteres to invoke javadoc
- buildJavadocs(self)
- Build the javadocs by reading java sources from the source folder, including
those in test is needed
Javadocs will be written in the destination folder.
Generation of jaavadocs is ddelegatred to Oracle' javadoc executable
@return: the code returned by calling javadoc
- getJavaPackagesRoot(self, srcFolders)
- Get the root folders of the java packages in the passed list of folders
@param srcFolders: the list of folders containg java sources
@return: the root of java packages (something like, com, org,...)
Methods inherited from IASApiDocs.DocGenerator.DocGenerator:
- checkFolders(self, src, dst)
- Check if the source and dest folders are valid and if it is not the case,
throws an exception
@param src: the folder with java sources to check
@param dst: destination folder to check
- containsSources(self, folder, fileExtension)
- @param folder: the folder (src or test) to check if contains java sources
@param fileExtension: the extension of the files that the folder is supposed to contain
@return: True if the passed folder contains java sources
- getSrcPaths(self, sourceFolder, includeTestFolder, folderName, fileExtension)
- Scan the source folder and return a list of source folders
containing source files.
Source can be contained into src or test (the latter is used only
if the includeTestFolder parameter is True)
The search is recursive because a folder can contain several modules
@param sourceFolder: root source folder (generally IAS, passed in the command line)
@param includeTestFolder: True to include test folders in the scan
@param folderName: the name of the folder containing the sources like java or python
@param fileExtension: the extension of the files that the folder is supposed to contain
Data descriptors inherited from IASApiDocs.DocGenerator.DocGenerator:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
| |