| | |
- builtins.object
-
- DocGenerator
class DocGenerator(builtins.object) |
| |
DocGenerator(srcFolder, dstFolder, outFile=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)
The base class for API docs generators
|
| |
Methods defined here:
- __init__(self, srcFolder, dstFolder, outFile=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)
- Constructor
@param srcFolder: the folder with sources to generate their documentation
@param dstFolder: destination folder for the api docs
@param outFile: the file where the output generated by calling java/scala/py-doc must be sent
- 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 defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
| |