Base class for naming files. You may derive from this class an reimplement any methods you like. The default implementation stores everything in the same directory (specified by -o).
| Operations Summary: | |
| __init__(self) [Source] | |
| copyFile(self, orig_name, new_name) Copies file if newer. [Source] | |
| _checkMain(self, filename) Checks whether the given filename is the main index page or not. [Source] | |
| nameOfScope(self, scope) Return the filename of a scoped name (class or module). [Source] | |
| _stripFilename(self, file) [Source] | |
| nameOfFileIndex(self, file) Return the filename for the index of an input file. [Source] | |
| nameOfFileSource(self, file) Return the filename for the source of an input file. [Source] | |
| nameOfFileDetails(self, file) Return the filename for the details of an input file. [Source] | |
| nameOfIndex(self) Return the name of the main index file. [Source] | |
| nameOfSpecial(self, name) Return the name of a special file (tree, etc). [Source] | |
| nameOfScopedSpecial(self, name, scope, ext = ".html") Return the name of a special type of scope file. [Source] | |
| nameOfModuleTree(self) Return the name of the module tree index. [Source] | |
| nameOfModuleIndex(self, scope) Return the name of the index of the given module. [Source] | |
| link(self, decl) Create a link to the named declaration. [Source] | |
| Operation Details: |
Copies file if newer. The file named by orig_name is compared to new_name, and if newer or new_name doesn't exist, it is copied.
Checks whether the given filename is the main index page or not. If it is, then it returns the filename from nameOfIndex(), else it returns it unchanged
Return the filename of a scoped name (class or module). The default implementation is to join the names with '-' and append ".html" Additionally, special characters are Util.quoted in URL-style
Return the filename for the index of an input file. The base_dir config option is used. Default implementation is to join the path with '-', prepend "_file-" and append ".html"
Return the filename for the source of an input file. The base_dir config option is used. Default implementation is to join the path with '-', prepend "_source-" and append ".html"
Return the filename for the details of an input file. The base_dir config option is used. Default implementation is to join the path with '-', prepend "_filedetail-" and append ".html"
Return the name of the main index file. Default is index.html
Return the name of a special file (tree, etc). Default is _name.html
Return the name of a special type of scope file. Default is to join the scope with '-' and prepend '-'+name
Return the name of the module tree index. Default is _modules.html
Return the name of the index of the given module. Default is to join the name with '-', prepend "_module_" and append ".html"
Create a link to the named declaration. This method may have to deal with the directory layout.