| | |
- IASApiDocs.DocGenerator.DocGenerator(builtins.object)
-
- ScaladocBuilder
class ScaladocBuilder(IASApiDocs.DocGenerator.DocGenerator) |
| |
ScaladocBuilder(src, dest, outFile=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)
Build scala API documentation
|
| |
- Method resolution order:
- ScaladocBuilder
- IASApiDocs.DocGenerator.DocGenerator
- builtins.object
Methods defined here:
- __init__(self, src, dest, outFile=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)
- Constructor
@param src: source folder to get scala files
@param dest: destination folder to write HTMLs into
@param outFile: the file where the output generated by calling javadoc must be sent
- buildScaladocs(self)
- Build the scaladoc in the destination folder
@return: the code returned by calling scaladoc
- getScalaSources(self, folder)
- Recursively scan the source folder to get scala source files
@param folder: the folder to scan for source files
@return: The liost of source files found in th efolder and its subfolders
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)
| |