Markers
Table of Contents
Configuration.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Environment.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 169 | use the original name | |
| 179 | use the unique, unresolved name | |
| 320 | a hack to avoid collisions between resolved and unresolved dependencies | |
| 323 | map the original dependency name to the one that will be stored | |
| 326 | the dependency is already a filename, probably a :doc: | |
| 327 | or from a toc-tree - change it to the canonical URL | |
| 340 | map the original dependency name to the one that will be stored | |
| TODO | 230 | is this used? |
FileCollector.php
| Type | Line | Description |
|---|---|---|
| 46 | completely populate the splFileInfos property | |
| 49 | Make paths relative to the provided source folder | |
| 84 | File is new or changed and thus need to be parsed | |
| 88 | Look to the file's dependencies to know if you need to parse it or not | |
| 111 | dependency no longer exists? We should re-parse this file | |
| 116 | finally, we need to recursively ask if this file needs parsing | |
| 122 | Meta is fresh and no dependencies need parsing | |
| 136 | File is new or changed |
Files.php
| Type | Line | Description |
|---|---|---|
| 9 | phpdoc.org |
Format.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
LoadCacheHandler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PersistCacheHandler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
RenderHandler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
InvalidLink.php
| Type | Line | Description |
|---|---|---|
| 9 | phpdoc.org |
LoadCacheCommand.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Parser.php
| Type | Line | Description |
|---|---|---|
| 84 | ignore all Entering events; these are only used to switch to another context and context switching | |
| 85 | is defined above |
Entry.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 147 | we only need to resolve a dependency one time |
Metas.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 136 | try to lookup the document reference by title |
DefaultNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DocumentNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FormatListRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FullDocumentNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DefinitionListNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DocumentNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ListRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SpanNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 49 | TODO: this is called in DocumentNode's getTitle function during parsing; wtf? | |
| 50 | return $this->renderer->render('nbsp.html.twig'); | |
| 57 | TODO: this is called in DocumentNode's getTitle function during parsing; wtf? | |
| 58 | return $this->renderer->render('br.html.twig'); | |
| 96 | reference to another document | |
| 106 | reference to anchor in existing document |
TableNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TocNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 92 | render children until we hit the configured maxdepth |
DocumentNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ListRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SpanNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TableNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TitleNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TocNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ListNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
NodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
NodeRendererFactory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SpanNodeRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 145 | Adding brs when a space is at the end of a line |
SpanRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
AnchorNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
BlockNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
CodeNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DefinitionListNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DocumentNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FigureNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
GenericNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ImageNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ListNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
MainNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
MetaNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Node.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ParagraphNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
QuoteNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
RawNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SectionBeginNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SectionEndNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SeparatorNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SpanNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TableColumn.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 43 | "\" is a special way to make a column "empty", but | |
| 44 | still indicate that you *want* that column |
TableRow.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 68 | iterate over each column and combine the content |
TableNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 198 | determine if there is second === separator line (other than | |
| 199 | the last line): this would mean there are header rows | |
| 202 | skip the first line: we're looking for the *next* line | |
| 207 | we found the next ==== line | |
| 209 | found the end of the header rows | |
| 216 | if the final header row is *after* the last data line, it's not | |
| 217 | really a header "ending" and so there are no headers | |
| 223 | todo - support "---" in the future for colspan | |
| 228 | loop over where all the columns should be | |
| 233 | check for content in the "gap" | |
| 244 | the text for this line ended earlier. This column should be blank | |
| 248 | this is the last column, so get the rest of the line | |
| 249 | this is because content can go *beyond* the table legally | |
| 268 | is header row? | |
| 278 | check for empty first columns, which means this is | |
| 279 | not a new row, but the continuation of the previous row | |
| 299 | loop over ALL separator lines to find ALL of the column ranges | |
| 316 | indicates that "=" was used | |
| 324 | we don't have this "start" yet? just add it | |
| 325 | in theory, should only happen for the first row | |
| 332 | an exact column range we've already seen | |
| 333 | OR, this new column goes beyond what we currently | |
| 334 | have recorded, which means its a colspan, and so | |
| 335 | we already have correctly recorded the "smallest" | |
| 336 | current column ranges | |
| 341 | this is not a new "start", but it is a new "end" | |
| 342 | this means that we've found a "shorter" column that | |
| 343 | we've seen before. We need to update the "end" of | |
| 344 | the existing column, and add a "new" column | |
| 347 | A) update the end of this column to the new end | |
| 349 | B) add a new column from this new end, to the previous end | |
| 361 | if the row is part separator row, part content, this | |
| 362 | is a rowspan situation - e.g. | |
| 363 | | +----------------+----------------------------+ | |
| 364 | look for +-----+ pattern | |
| 374 | a content line that ends before it should | |
| 391 | text continued through the "gap". This is a colspan | |
| 392 | "+" is an odd character - it's usually "|", but "+" can | |
| 393 | happen in row-span situations | |
| 396 | we just hit a proper "gap" record the line up until now | |
| 406 | if the current column start is null, then set it | |
| 407 | other wise, leave it - this is a colspan, and eventually | |
| 408 | we want to get all the text starting here | |
| 416 | record the last column | |
| 434 | this row is part content, part separator due to a rowspan | |
| 435 | for each column that contains content, we need to | |
| 436 | push it onto the last real row's content and record | |
| 437 | that this column in the next row should also be | |
| 438 | included in that previous row's content | |
| 445 | only a line separator in this column - not content! | |
| 452 | mark that this column on the next row should also be added | |
| 453 | to the previous row | |
| 457 | remove the row - it's not real | |
| 463 | check if the previous row was a partial separator row, and | |
| 464 | we need to take some columns and add them to a previous row's content | |
| 474 | now this column actually needs to be removed from this row, | |
| 475 | as it's not a real column that needs to be printed | |
| 481 | if the next row is just $i+1, it means there | |
| 482 | was no "separator" and this is really just a | |
| 483 | continuation of this row. | |
| 486 | but if the next line is actually a partial separator, then | |
| 487 | it is not a continuation of the content - quit now | |
| 505 | one more loop to set headers | |
| 547 | go through the rows backwards to find the last/previous | |
| 548 | row that actually had a real column at this position | |
| 550 | start by skipping any future rows, as we go backward |
TitleNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TocNode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Parser.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PersistCacheCommand.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Doc.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 19 | www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html |
NamespaceReference.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 23 | docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html |
PhpClassReference.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 21 | docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html |
PhpFunctionReference.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 22 | docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html |
PhpMethodReference.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 24 | www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#python-roles |
Reference.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 26 | docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html |
ResolvedReference.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Resolver.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
RenderCommand.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Renderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 68 | pre-set the global variable so that we can update it later | |
| TODO | 97 | I am not convinced that such a specific solution for Guides would be best since it is used in the Assets extension; and this extension would actually be nice to re-use in the rest of phpDocumentor as well. First, make it work here; then adapt for the rest :) |
CodeBlock.php
| Type | Line | Description |
|---|---|---|
| 21 | www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block |
Directive.php
| Type | Line | Description |
|---|---|---|
| 49 | Ensure options are always available |
AbstractAdmonitionDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
AdmonitionDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
BestPracticeDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
CautionDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ConfigurationBlockDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DeprecatedDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
HintDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ImportantDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
IndexDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
NoteDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
RoleDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SeeAlsoDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SidebarDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TipDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TopicDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
VersionAddedDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
WarningDirective.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 20 | we render warning and caution the same |
HTMLFormat.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DocumentParser.php
| Type | Line | Description |
|---|---|---|
| 171 | Removing UTF-8 BOM | |
| 174 | Replace \u00a0 with " " | |
| 200 | DocumentNode is flushed twice to trigger the directives | |
| 302 | not sure if this is possible, being cautious | |
| 307 | push the separator or content line onto the TableNode | |
| 419 | current level is less than previous so we need to end all open sections | |
| 425 | same level as the last so just close the last open section |
LineDataParser.php
| Type | Line | Description |
|---|---|---|
| 35 | Links | |
| 40 | anonymous links | |
| 45 | Short anonymous links | |
| 52 | Anchor links - ".. _`anchor-link`:" | |
| 151 | term definition line | |
| 157 | non empty string | |
| 159 | we are starting a new term so if we have an existing | |
| 160 | term with definitions, add it to the definition list | |
| 187 | last line | |
| 204 | empty line, start of a new definition for the current term |
TableParser.php
| Type | Line | Description |
|---|---|---|
| 18 | "-" is valid as a separator in a simple table, except | |
| 19 | on the first and last lines | |
| 43 | Finds the table chars | |
| 52 | reverse the chars: - is the line char, + is the space char | |
| 57 | reverse the chars: = is the line char, + is the space char | |
| 60 | either a simple table or not a separator line | |
| 62 | if line char is not "=" or "-", not a separator line | |
| 67 | if space char is not a space, not a separator line | |
| 78 | we found the "line char": "-" or "=" | |
| 91 | found the "space" char | |
| 92 | record the part "range" if we're at the end of a range | |
| 101 | finish the last "part" |
SpanProcessor.php
| Type | Line | Description |
|---|---|---|
| 157 | Signaling anonymous names | |
| 164 | string prefixed with _ is not an anonymous link | |
| 177 | a link starting with _ is not a link - return original string | |
| 182 | the link may have a new line in it so we need to strip it | |
| 183 | before setting the link and adding a token to be replaced | |
| 187 | we need to maintain the characters before and after the link | |
| 188 | previous character before the link | |
| 189 | next character after the link | |
| 193 | extract the url if the link was in this format: `test link <https://www.google.com>`_ | |
| 201 | extract the url if the link was in this format: `<https://www.google.com>`_ | |
| 223 | Replacing anonymous links | |
| 230 | Replacing links | |
| 242 | Replace standalone hyperlinks using a modified version of @gruber's | |
| 243 | "Liberal Regex Pattern for all URLs", https://gist.github.com/gruber/249502 | |
| 248 | Standalone hyperlink callback | |
| 274 | Replace standalone email addresses using a regex based on RFC 5322. |
GlobSearcher.php
| Type | Line | Description |
|---|---|---|
| 40 | remove the root directory so it is a relative path from the root | |
| 43 | recursively search in this directory | |
| 48 | Trim the root path and the .rst extension. This is what the | |
| 49 | RST parser requires to add a dependency. |
ToctreeBuilder.php
| Type | Line | Description |
|---|---|---|
| 45 | if glob finds a file already explicitly defined | |
| 46 | don't duplicate it in the toctree again |
TemplateRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
AssetsExtension.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 69 | make it relative so it plays nice with the base tag in the HEAD |
UrlGenerator.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| TODO | 79 | simplify this method into the other methods or vice versa |
Application.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 43 | when installed using composer the templates are in a different folder | |
| 70 | @codeCoverageIgnoreStart | |
| 90 | www.php.net/function.date-default-timezone-get for more information how PHP determines the |
AutoloaderLocator.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 39 | getcomposer.org/doc/03-cli.md#composer-vendor-dir COMPOSER_VENDOR_DIR environment variable} | |
| 45 | getcomposer.org/doc/03-cli.md#composer COMPOSER environment variable}). If this file | |
| 46 | getcomposer.org/doc/06-config.md#vendor-dir vendor-dir entry}, its value will be | |
| 61 | Composerised installation, vendor/phpdocumentor/phpdocumentor/src/phpDocumentor is __DIR__ | |
| 66 | Repository cloned via git | |
| 72 | Do not use realpath() here to don't break installation from phar | |
| 82 | getcomposer.org/doc/03-cli.md#composer COMPOSER environment variable} | |
| 94 | getcomposer.org/doc/03-cli.md#composer-vendor-dir COMPOSER_VENDOR_DIR environment variable}, | |
| 95 | getcomposer.org/doc/06-config.md#vendor-dir vendor-dir entry} of the given composer.json, |
Compiler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
CompilerPassInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DescriptorRepository.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 68 | first exchange `@context::element` for `\My\Class::element` and if it exists, return that | |
| 74 | otherwise exchange `@context::element` for `\My\element` and if it exists, return that | |
| 81 | otherwise check if the element exists in the global namespace and if it exists, return that | |
| 88 | Otherwise we assume it is an undocumented class/interface/trait and return `\My\element` so | |
| 89 | that the name containing the marker may be replaced by the class reference as string |
Debug.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ElementsIndexBuilder.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
MarkerFromTagsExtractor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
NamespaceTreeBuilder.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 86 | TODO: find out why this can happen. Some bug in the assembler? | |
| 108 | replace textual representation with an object representation | |
| 111 | add element to namespace | |
| 149 | bit hacky but it works for now. | |
| 150 | $project->getNamespace()->getChildren()->add($namespace); |
PackageTreeBuilder.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 113 | ensure consistency by trimming the slash prefix and then re-appending it. | |
| 122 | replace textual representation with an object representation | |
| 125 | add element to package | |
| 156 | this method does not use recursion to traverse the tree but uses a pointer that will be overridden with the | |
| 157 | next item that is to be traversed (child package) at the end of the loop. | |
| 168 | package does not exist, create it | |
| 174 | add to the pointer's list of children | |
| 177 | add to index | |
| 180 | move pointer forward |
RemoveSourcecode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ResolveInlineMarkers.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 50 | [\s]*(' . implode('|', $markerTerms) . ')\:?[\s]*(.*)~', | |
| 57 | fetches all the text before the match |
TableOfContentsBuilder.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 45 | This looks ugly, when versions are introduced we get rid of these 2 foreach loops. |
ApiSpecification.php
| Type | Line | Description |
|---|---|---|
| 100 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 104 | phpcs:enable Generic.Files.LineLength.TooLong |
CommandlineOptionsMiddleware.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 172 | this will ensure that if we receive an array with comma-separated values; that we make a single array with | |
| 173 | all values split | |
| 181 | Reset the current config, because directory is overwriting the config. | |
| 186 | If the passed directory is an absolute path this should be handled as a new Api | |
| 187 | A version may contain multiple APIs. |
Configuration.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ConfigurationFactory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 120 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 124 | phpcs:enable Generic.Files.LineLength.TooLong |
Normalizable.php
| Type | Line | Description |
|---|---|---|
| 12 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 18 | phpcs:enable Generic.Files.LineLength.TooLong |
Upgradable.php
| Type | Line | Description |
|---|---|---|
| 9 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 28 | phpcs:enable Generic.Files.LineLength.TooLong |
Version2.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 150 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 160 | phpcs:enable Generic.Files.LineLength.TooLong | |
| 221 | www.gnu.org/software/bash/manual/html_node/Pattern-Matching.html | |
| TODO | 161 | not all options are included yet; finish this |
Version3.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 67 | We need to revert the phpize call in XmlUtils. Version number is always a string! | |
| 117 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 123 | phpcs:enable Generic.Files.LineLength.TooLong | |
| 131 | for array normalization to work, I need to use fixXmlConfig; but that doesn't seem to work | |
| 132 | when you want to keep the key the same (api => api) but requires the plural to be differently named. | |
| 133 | the rest of the app doesn't use a plural; so I undo that pluralisation here. | |
| 189 | only include elements tagged with the `@api` tag | |
| 190 | include all methods, properties and constants that are public | |
| 191 | include all methods, properties and constants that are protected | |
| 192 | include all methods, properties and constants that are private | |
| 193 | include all elements tagged with `@internal` |
InvalidConfigPathException.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
UnSupportedConfigVersionException.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
LegacyArrayAccess.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
MiddlewareInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PathNormalizingMiddleware.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ProvideTemplateOverridePathMiddleware.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Source.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SymfonyConfigFactory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 44 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 48 | phpcs:enable Generic.Files.LineLength.TooLong | |
| 57 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 61 | phpcs:enable Generic.Files.LineLength.TooLong | |
| 69 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 75 | phpcs:enable Generic.Files.LineLength.TooLong | |
| 86 | prefix is needed because other parts of the application require 'phpdocumentor' as root | |
| 87 | it would be nice to refactor this necessity away at some point | |
| 91 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 103 | phpcs:enable Generic.Files.LineLength.TooLong | |
| 138 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 144 | phpcs:enable Generic.Files.LineLength.TooLong |
VersionSpecification.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Application.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 50 | Empty by purpose | |
| 53 | the regular setDefaultCommand option does not allow for options and arguments; with this workaround | |
| 54 | we can have options and arguments when the first element in the argv options is not a recognized | |
| 55 | command name. | |
| 92 | prevent replacing the version by the PEAR building | |
| 95 | @codeCoverageIgnoreStart | |
| 102 | @codeCoverageIgnoreEnd |
ListSettingsCommand.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
RunCommand.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 309 | Code that is poorly testable and not worth the effort | |
| 310 | @codeCoverageIgnoreStart | |
| 348 | @codeCoverageIgnoreEnd |
ReflectionProjectFactoryStrategyPass.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ApiSetDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ArgumentDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
AssemblerAbstract.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
AssemblerFactory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
AssemblerInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 24 | phpcs:disable | |
| 33 | phpcs:enable |
AssemblerMatcher.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ArgumentAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
AssemblerAbstract.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 94 | allow filtering of tags |
ClassAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ConstantAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 41 | Reflection library formulates namespace as global but this is not wanted for phpDocumentor itself |
FileAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 63 | $this->addMarkers($data->getMarkers(), $fileDescriptor); |
FunctionAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 70 | TODO: this looks like a potential bug. Have to investigate this! |
InterfaceAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 46 | Reflection library formulates namespace as global but this is not wanted for phpDocumentor itself |
MethodAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
NamespaceAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PropertyAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
AuthorAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DeprecatedAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ExampleAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
GenericTagAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
LinkAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
MethodAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ParamAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PropertyAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ReturnAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SeeAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SinceAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ThrowsAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
UsesAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
VarAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
VersionAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TraitAssembler.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 46 | Reflection library formulates namespace as global but this is not wanted for phpDocumentor itself |
ProjectDescriptorMapper.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 79 | store the settings for this Project Descriptor | |
| 83 | store cache items | |
| 99 | remove any keys that are no longer used. |
ClassDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Collection.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ConstantDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Descriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DescriptorAbstract.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DocumentationSetDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DocumentDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
MissingDependencyException.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FileDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 287 | TODO: This is an item that needs to be done. |
Filter.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Filterable.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
StripIgnore.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
StripInternal.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 28 | docs.phpdoc.org/latest/references/phpdoc/tags/internal.html | |
| 51 | remove inline @internal tags | |
| 62 | if internal elements are not allowed; filter this element |
StripOnVisibility.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 37 | if a Descriptor is marked as 'api' and this is set as a visibility; _always_ show it; even if the visibility | |
| 38 | is not set |
FunctionDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
GuideSetDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
InterfaceDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ArgumentInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 33 | github.com/phpDocumentor/phpDocumentor2/blob/develop/docs/PSR.md#appendix-a-types Definition of a | |
| TODO | 40 | update link to point to the final destination for the PHPDoc Standard. |
ChildInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ClassInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ConstantInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ContainerInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ElementInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FileInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FunctionInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
InterfaceInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
MethodInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
NamespaceInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PackageInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ProjectInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PropertyInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 26 | docs.phpdoc.org/latest/references/phpdoc/tags/property-read.html | |
| 33 | docs.phpdoc.org/latest/references/phpdoc/tags/property-write.html |
TraitInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TypeInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
VisibilityInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
MethodDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 71 | reset cached inherited element so that it can be re-detected. | |
| 242 | the parent of a class is always a class, but the parent of an interface is a collection of interfaces. | |
| 256 | also check all implemented interfaces next if the parent is a class and not an interface |
NamespaceDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 68 | phpcs:disable SlevomatCodingStandard.Classes.ModernClassNameReference.ClassNameReferencedViaMagicConstant |
PackageDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ProjectAnalyzer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Settings.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
WithCustomSettings.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ProjectDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ProjectDescriptorBuilder.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 101 | create Descriptor and populate with the provided data | |
| 151 | filter the descriptor; this may result in the descriptor being removed! | |
| 166 | We assume that the custom settings have the non-default settings and we should not override those; | |
| 167 | that is why we merge the custom settings on top of the default settings; this will cause the overrides | |
| 168 | to remain in place. |
PropertyDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Entry.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
AuthorDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TypedAbstract.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TypedVariableAbstract.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
DeprecatedDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ExampleDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
LinkDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
MethodDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ParamDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PropertyDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ReturnDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SeeDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SinceDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ThrowsDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
UsesDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
VarDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
VersionDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TagDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TraitDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Error.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
VersionDescriptor.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Dsn.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 34 | www.php.net/manual/en/ref.pdo-mysql.connection.php}) where you have a string containing Semicolon | |
| 40 | /home/mvriel/project/src | |
| 44 | github.com/phpDocumentor/phpDocumentor;path=/src;branch=release/3.0 | |
| 100 | ' . $this->getPath(); |
Dispatcher.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
EventAbstract.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Kernel.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FilesystemAdapter.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Locator.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PreFileEvent.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PreParsingEvent.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FilesNotFoundException.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FileCollector.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FileFactory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FileSystemFactory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FlySystemCollector.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FlySystemFactory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 71 | VFS does not support locking | |
| 77 | / scheme from the dsn when needed. | |
| 79 | / on all windows |
FlySystemFile.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FlySystemMirror.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 29 | ' . $sourcePath, true); | |
| 30 | ' . $destinationPath); | |
| 34 | ' . $destinationPath . '/' . $fileNode['path']); | |
| 39 | ' . $destinationPath . '/' . $fileNode['path'], | |
| 40 | ' . $sourcePath . '/' . $fileNode['path']) |
CacheMiddleware.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
EmittingMiddleware.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ErrorHandlingMiddleware.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 56 | when an error occurs, return an empty file with an empty hash; this means phpDocumentor will try to | |
| 57 | re-parse the file every time |
ReEncodingMiddleware.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
StopwatchMiddleware.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Parser.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ReEncodedFile.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SpecificationFactory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
SpecificationFactoryInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Path.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PipelineFactory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
GarbageCollectCache.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PurgeCachesWhenForced.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
StoreGuidesToCache.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
StoreProjectDescriptorToCache.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Compile.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Configure.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 90 | if the path equals none then we fallback to the defaults but don't load anything from the filesystem |
InitializeBuilderFromConfig.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
CollectFiles.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ParseFiles.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ParseGuides.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Payload.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 31 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 36 | phpcs:enable Generic.Files.LineLength.TooLong | |
| 43 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 47 | phpcs:enable Generic.Files.LineLength.TooLong | |
| 50 | Grep only the first version for now. Multi version support will be added later |
TransformToParserPayload.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Payload.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 23 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 25 | phpcs:enable Generic.Files.LineLength.TooLong | |
| 31 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 35 | phpcs:enable Generic.Files.LineLength.TooLong | |
| 42 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 46 | phpcs:enable Generic.Files.LineLength.TooLong |
Transform.php
| Type | Line | Description |
|---|---|---|
| 152 | TODO: the guides to need this, can we get rid of these lines? |
TransformToPayload.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 31 | phpcs:disable Generic.Files.LineLength.TooLong | |
| 35 | phpcs:enable Generic.Files.LineLength.TooLong |
PostTransformationEvent.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PostTransformEvent.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PreTransformationEvent.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
PreTransformEvent.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
WriterInitializationEvent.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Exception.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ClassBasedFqsenUrlGenerator.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Router.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 144 | if this is a link to an external page; return that URL | |
| 149 | We could not match the node to any known routable thing |
Collection.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 17 | phpcs:ignore SlevomatCodingStandard.Namespaces.UnusedUses.UnusedUse |
Factory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 118 | skip abstract files | |
| 149 | create the filesystems that a template needs to be able to manipulate, the source folder containing this | |
| 150 | template its files; the destination to where it can write its files and a global templates folder where to | |
| 151 | get global template files from | |
| 160 | ' . self::TEMPLATE_DEFINITION_FILENAME); | |
| 213 | if we load a global template |
Parameter.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
TemplateNotFound.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Template.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 141 | , the files of this template | |
| 142 | , the base folder containing phpDocumentor's global templates (i.e. `/data/templates`) | |
| 143 | , the destination where the template needs to write to | |
| 213 | www.php.net/arrayaccess.offsetunset | |
| 225 | www.php.net/arrayaccess.offsetexists | |
| 239 | www.php.net/countable.count |
Transformation.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Transformer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Collection.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
RequirementMissing.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FileIo.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Generator.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
GraphVizClassDiagram.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 122 | NOTE: the -V flag sends output using STDERR and STDOUT | |
| 170 | push the classname off the stack | |
| 243 | $full_name = $subElement->getFullyQualifiedStructuralElementName(); | |
| 244 | $node->setURL($this->class_paths[$full_name]); | |
| 245 | $node->setTarget('_parent'); |
PlantumlClassDiagram.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Graph.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Initializable.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
IoTrait.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 72 | always strip the folder name as we want the path as it is 'inside' the destination folder | |
| 73 | ex. images/subfolder/image1.png should become subfolder/image1.png as the $destination variable | |
| 74 | already contains 'images' | |
| 77 | if the provided $path is a reference to a global template, then we need to strip another level | |
| 78 | since that contains the templateName | |
| 85 | ' . $file['path'], | |
| 104 | ') === 0; | |
| 109 | if it has a scheme, it must have been normalized before | |
| 115 | the base folder of the global filesystem is already templates; so we need to strip that off | |
| 116 | ' . $this->stripFirstPartOfPath($path); | |
| 119 | ' . $path; | |
| 124 | prepend destination scheme if none was set | |
| 126 | ' . $destination; |
Pathfinder.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 64 | walk through the tree |
PathGenerator.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 98 | explicitly do not use the unicode modifier; this breaks windows | |
| 107 | Find value in Descriptor's properties / methods | |
| 110 | strip any special characters and surrounding \ or / | |
| 113 | make it windows proof by transliterating to ASCII and by url encoding |
RenderGuide.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 64 | Feature flag: Guides are disabled by default since this is an experimental feature |
Sourcecode.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
EnvironmentFactory.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
Extension.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
ExtensionInterface.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
FlySystemLoader.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
LinkRenderer.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 253 | do nothing; apparently this was not an FQSEN | |
| 269 | With an unlinked object, we don't know if the page for it exists; so we don't render a link to it. | |
| 271 | With an unlinked object and the class:short presentation; only show the last bit | |
| 300 | do nothing; the url apparently is not valid enough; let's just pass it on | |
| 305 | return the first url | |
| 391 | Ensure it is prefixed with a \; as without it it cannot be a valid FQSEN |
Twig.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org |
WriterAbstract.php
| Type | Line | Description |
|---|---|---|
| 11 | phpdoc.org | |
| 36 | empty body since most writers do not have requirements |
UriFactory.php
| Type | Line | Description |
|---|---|---|
| 27 | ') === 0) { | |
| 32 | /') === 0) { | |
| 33 | /')); | |
| 55 | ')); |