Mercurial Repositories > eric / file comparison
comparison: src/eric7/DocumentationTools/IndexGenerator.py
src/eric7/DocumentationTools/IndexGenerator.py
- branch
- eric7
- changeset 10423
- 299802979277
- parent 10373
- 093dcebe5ecb
- child 10439
- 21c28b0f9e41
equal
deleted
inserted
replaced
| 10422:e28b89693f37 | 10423:299802979277 |
|---|---|
| 37 | 37 |
| 38 def remember(self, file, moduleDocument, basename=""): | 38 def remember(self, file, moduleDocument, basename=""): |
| 39 """ | 39 """ |
| 40 Public method to remember a documentation file. | 40 Public method to remember a documentation file. |
| 41 | 41 |
| 42 @param file The filename to be remembered. (string) | 42 @param file The filename to be remembered. |
| 43 @param moduleDocument The ModuleDocument object containing the | 43 @type str |
| 44 information for the file. | 44 @param moduleDocument module documentation object containing the |
| 45 @param basename The basename of the file hierarchy to be documented. | 45 information for the file |
| 46 The basename is stripped off the filename if it starts with | 46 @type ModuleDocument |
| 47 the basename. | 47 @param basename base name of the file hierarchy to be documented. |
| 48 The base name is stripped off the filename if it starts with | |
| 49 the base name. | |
| 50 @type str | |
| 48 """ | 51 """ |
| 49 self.remembered = True | 52 self.remembered = True |
| 50 if basename: | 53 if basename: |
| 51 file = file.replace(basename, "") | 54 file = file.replace(basename, "") |
| 52 | 55 |
| 82 | 85 |
| 83 def __writeIndex(self, packagename, package, newline=None): | 86 def __writeIndex(self, packagename, package, newline=None): |
| 84 """ | 87 """ |
| 85 Private method to generate an index file for a package. | 88 Private method to generate an index file for a package. |
| 86 | 89 |
| 87 @param packagename The name of the package. (string) | 90 @param packagename The name of the package. |
| 88 @param package A dictionary with information about the package. | 91 @type str |
| 89 @param newline newline character to be used (string) | 92 @param package dictionary with information about the package |
| 90 @return The name of the generated index file. | 93 @type dict |
| 94 @param newline newline character to be used | |
| 95 @type str | |
| 96 @return name of the generated index file | |
| 97 @rtype str | |
| 91 """ | 98 """ |
| 92 if packagename == "00index": | 99 if packagename == "00index": |
| 93 f = os.path.join(self.outputDir, "index") | 100 f = os.path.join(self.outputDir, "index") |
| 94 title = "Table of contents" | 101 title = "Table of contents" |
| 95 else: | 102 else: |
| 168 | 175 |
| 169 def writeIndices(self, basename="", newline=None): | 176 def writeIndices(self, basename="", newline=None): |
| 170 """ | 177 """ |
| 171 Public method to generate all index files. | 178 Public method to generate all index files. |
| 172 | 179 |
| 173 @param basename The basename of the file hierarchy to be documented. | 180 @param basename base name of the file hierarchy to be documented. |
| 174 The basename is stripped off the filename if it starts with | 181 The base name is stripped off the filename if it starts with |
| 175 the basename. | 182 the base name. |
| 176 @param newline newline character to be used (string) | 183 @type str |
| 184 @param newline newline character to be used | |
| 185 @type str | |
| 177 """ | 186 """ |
| 178 if not self.remembered: | 187 if not self.remembered: |
| 179 sys.stderr.write("No index to generate.\n") | 188 sys.stderr.write("No index to generate.\n") |
| 180 return | 189 return |
| 181 | 190 |
