2019-02-21 --> 2021-05-31
- ClassParser – The ClassParser class is a generic implementation of the ClassParserInterface.
- ClassParser::__construct – Builds the ClassParser instance.
- ClassParser::parse – Returns a ClassInfo object from the given $className.
- ClassParser::setResolveInlineTags – Sets the resolveInlineTags.
- ClassParser::getReport – Returns the report of this instance.
- ClassParser::setReport – Sets the report.
- ClassParser::setNotationlInterpreter – Sets the notationInterpreter.
- ClassParser::setGeneratedItemsToUrl – Sets the generatedItems2Url.
- ClassParserInterface – The ClassParserInterface interface represents a class parser.
- ClassParserInterface::parse – Returns a ClassInfo object from the given $className.
- ClassParserInterface::getReport – Returns the parser report.
- CopyModule – The CopyModule class.
- CopyModule::copy – Copies the $sourceDir recursively to the $destinationDir, using the given $interpreter during the transfer.
- CopyModuleInterface – The CopyModuleInterface interface.
- CopyModuleInterface::copy – Copies the $sourceDir recursively to the $destinationDir, using the given $interpreter during the transfer.
- DocBuilder – The DocBuilder class.
- DocBuilder::prepare – Prepares the doc builder instance.
- DocBuilder::buildDoc – and according to the writeMode property.
- DocBuilder::showReport – Displays the report.
- DocBuilder::getReport – Returns the report instance.
- LingGitPhpPlanetDocBuilder – The LingGitPhpPlanetDocBuilder class.
- LingGitPhpPlanetDocBuilder::prepare – Prepares the doc builder instance.
- LingGitPhpPlanetDocBuilder::buildDoc – and according to the writeMode property.
- DocBuilder::showReport – Displays the report.
- DocBuilder::getReport – Returns the report instance.
- BadWidgetConfigurationException – cannot render properly.
- ClassParserException – DocTools\ClassParser\ClassParser class when it encounters a problem.
- CopyModuleException – encounters a problem.
- DocBuilderException – The DocBuilderException class is thrown when a problems occurs with a doc builder.
- DocToolsException – The DocToolsException class is the base class for all the exceptions of the DocTools planet.
- PlanetParserException – DocTools\PlanetParser\PlanetParser class when it encounters a problem.
- DefaultGeneratedDocStyle – The DefaultGeneratedDocStyle class.
- DefaultGeneratedDocStyle::__construct – Builds the DefaultGeneratedDocStyle instance.
- DefaultGeneratedDocStyle::setExtension – Sets the extension.
- DefaultGeneratedDocStyle::getClassUrl – Returns the class url.
- DefaultGeneratedDocStyle::getMethodUrl – Returns the method url.
- DefaultGeneratedDocStyle::getPlanetPageRelativePath – Returns the relative path to the planet documentation page.
- DefaultGeneratedDocStyle::getClassPageRelativePath – Returns the relative path to the class documentation page.
- DefaultGeneratedDocStyle::getMethodPageRelativePath – Returns the relative path to the method documentation page.
- GeneratedDocStyleInterface – The GeneratedDocStyleInterface interface.
- GeneratedDocStyleInterface::getClassUrl – Returns the class url.
- GeneratedDocStyleInterface::getMethodUrl – Returns the method url.
- GeneratedDocStyleInterface::getPlanetPageRelativePath – Returns the relative path to the planet documentation page.
- GeneratedDocStyleInterface::getClassPageRelativePath – Returns the relative path to the class documentation page.
- GeneratedDocStyleInterface::getMethodPageRelativePath – Returns the relative path to the method documentation page.
- GenericParserInterface – The GenericParserInterface interface is a generic interface for parsers.
- GenericParserInterface::parse – Parses the given $element and returns a Ling\DocTools\Info\InfoInterface object.
- ClassNameHelper – The ClassNameHelper class.
- ClassNameHelper::getClassNameInfo – Returns an array of info corresponding to the given $className, or returns false if the url cannot be found.
- ClassParserHelper – The ClassParserHelper class.
- ClassParserHelper::getAncestorClassesWithMethod – Returns the \ReflectionClass of the ancestors (of the given $class) having the given $method.
- CommentHelper – The CommentHelper class.
- CommentHelper::displaySeeAlsoItemsSentence – Returns a human sentence out of the see items collected into the given CommentInfo instance.
- MethodHelper – The MethodHelper class.
- MethodHelper::getMethodReturnType – Returns the method's return type, with links to class names when possible.
- MethodHelper::getMethodSignature – Returns a method signature with links to class names when possible.
- PhpClassHelper – The PhpClassHelper class.
- PhpClassHelper::getClasses2Urls – Returns a map of php class to url.
- TagHelper – The TagHelper class.
- TagHelper::getTagInfo – Returns the tag info associated with an expandable block-level tag.
- ClassInfo – The ClassInfo class.
- ClassInfo::__construct – Builds the ClassInfo instance.
- ClassInfo::getComment – Returns the comment, or null if the comment doesn't exist.
- ClassInfo::getProperties – Returns an array of PropertyInfo.
- ClassInfo::getMethods – Returns an array of MethodInfo.
- ClassInfo::getOwnMethods – Returns the list of MethodInfo declared by this class (i.e.
- ClassInfo::setComment – Sets the comment.
- ClassInfo::addProperty – Adds a property.
- ClassInfo::addMethod – Adds a method to this classInfo instance.
- ClassInfo::getName – Returns the name of the class.
- ClassInfo::setName – Sets the name.
- ClassInfo::getSignature – Returns the signature.
- ClassInfo::setSignature – Sets the signature.
- ClassInfo::getShortName – Returns the class short name.
- ClassInfo::setShortName – Sets the class short name.
- ClassInfo::getInterfaces – Returns the interface class names.
- ClassInfo::setInterfaces – Sets the interface class names.
- ClassInfo::getReflectionClass – Returns the reflectionClass of this instance.
- ClassInfo::setReflectionClass – Sets the reflectionClass.
- ClassInfo::hasProperties – Returns whether the class has (direct) properties.
- CommentInfo – The CommentInfo class.
- CommentInfo::__construct – Builds the CommentInfo instance.
- CommentInfo::getRawText – Returns the raw text.
- CommentInfo::getMainText – Returns the main text.
- CommentInfo::hasEmptyMainText – Returns whether the main text of this comment is empty.
- CommentInfo::getTagContent – Returns the body of the given $tag, or the $default value if the tag isn't defined.
- CommentInfo::getTags – The getTags method
- CommentInfo::getTagsByName – Returns all tags with the given $tagName associated with this comment.
- CommentInfo::getTagByName – Returns the first $tagName tag associated with this comment.
- CommentInfo::hasTag – Returns whether the comment has the tag $tagName.
- CommentInfo::setRawText – Sets the raw text of this comment.
- CommentInfo::setMainText – Sets the main text of the comment.
- CommentInfo::setTags – Sets the tags for this comment.
- CommentInfo::getFirstLine – Returns the first line of the main text (see class description for more details).
- CommentInfo::setFirstLine – Sets the first line for this comment.
- CommentInfo::getFirstSentence – Returns the firstSentence of this instance.
- CommentInfo::setFirstSentence – Sets the firstSentence.
- CommentInfo::isEmpty – Returns whether the comment is empty.
- CommentInfo::getSeeItems – Returns the seeItems of this instance.
- CommentInfo::setSeeItems – Sets the seeItems.
- CommentInfo::getIncludeReferences – Returns the includeReferences of this instance.
- CommentInfo::setIncludeReferences – Sets the includeReferences.
- InfoInterface – The InfoInterface interface is the interface for all info objects.
- MethodInfo – The MethodInfo class represents information about a method (of a class).
- MethodInfo::__construct – Builds the MethodInfo instance.
- MethodInfo::getVisibility – Returns the visibility of the method.
- MethodInfo::setVisibility – Sets the visibility for this method.
- MethodInfo::getComment – Returns the CommentInfo instance.
- MethodInfo::setComment – Sets the comment for this instance.
- MethodInfo::getSignature – Returns the signature of this method.
- MethodInfo::setSignature – Sets the signature.
- MethodInfo::getName – Returns the name of the method.
- MethodInfo::setName – Sets the name of the method.
- MethodInfo::getReflectionMethod – Returns the reflectionMethod of this instance.
- MethodInfo::setReflectionMethod – Sets the reflectionMethod.
- MethodInfo::getDeclaringClass – Returns the declaringClass of this instance.
- MethodInfo::getReturnType – Returns the returnType of this instance.
- MethodInfo::setReturnType – Sets the returnType.
- MethodInfo::setReturnDescription – Sets the returnDescription.
- MethodInfo::hasParameters – Returns whether the method has at least one parameter.
- MethodInfo::addParameter – Adds a DocTools\Info\ParameterInfo to this instance.
- MethodInfo::getParameters – Returns the parameters of this instance.
- MethodInfo::getReturnDescription – Returns the returnDescription of this instance.
- MethodInfo::getThrownExceptions – Returns the thrownExceptions of this instance.
- MethodInfo::hasThrownExceptions – Returns whether this methodInfo contains thrownExceptions.
- MethodInfo::setThrownExceptions – Sets the thrownExceptions.
- ParameterInfo – The ParameterInfo class.
- ParameterInfo::__construct – Builds the ParameterInfo instance.
- ParameterInfo::getName – Returns the name of this instance.
- ParameterInfo::setName – Sets the name.
- ParameterInfo::getType – Returns the type of this instance.
- ParameterInfo::setType – Sets the type.
- ParameterInfo::getDefaultValue – Returns the defaultValue of this instance.
- ParameterInfo::setDefaultValue – Sets the defaultValue.
- ParameterInfo::getValueAlternatives – Returns the valueAlternatives of this instance.
- ParameterInfo::setValueAlternatives – Sets the valueAlternatives.
- ParameterInfo::getDescriptiveText – Returns the descriptiveText of this instance.
- ParameterInfo::setDescriptiveText – Sets the descriptiveText.
- PlanetInfo – The PlanetInfo class.
- PlanetInfo::__construct – Builds the PlanetInfo instance.
- PlanetInfo::getDependencies – Returns the array of dependencies to other planets.
- PlanetInfo::setDependencies – Sets the dependencies for this instance.
- PlanetInfo::getClasses – Returns the array of ClassInfo instances found in this planet.
- PlanetInfo::addClass – Adds a class to this instance.
- PlanetInfo::getClass – or null otherwise.
- PlanetInfo::getName – Returns the name of the planet.
- PlanetInfo::setName – Sets the name of this planet.
- PropertyInfo – The PropertyInfo class represents information about a property (of a class).
- PropertyInfo::__construct – Builds the PropertyInfo instance.
- PropertyInfo::getComment – Returns the CommentInfo instance for this property.
- PropertyInfo::setComment – Sets the comment.
- PropertyInfo::getName – Returns the name of this property.
- PropertyInfo::setName – Sets the name of this property.
- PropertyInfo::getSignature – Returns the signature for this property.
- PropertyInfo::setSignature – Sets the signature for this property.
- PropertyInfo::getVisibility – Returns the visibility of this instance.
- PropertyInfo::setVisibility – Sets the visibility.
- PropertyInfo::getDeclaringClass – Returns the declaringClass of this instance.
- PropertyInfo::getReflectionProperty – Returns the reflectionProperty of this instance.
- PropertyInfo::setReflectionProperty – Sets the reflectionProperty.
- PropertyInfo::getDefaultValue – Returns the default value of this property, or null if there is no default value.
- PropertyInfo::getType – Returns the type of this instance.
- PropertyInfo::setType – Sets the type.
- ThrownExceptionInfo – written in a method.
- ThrownExceptionInfo::__construct – Builds the ThrownExceptionInfo instance.
- ThrownExceptionInfo::getShortName – Returns the shortName of this instance.
- ThrownExceptionInfo::setShortName – Sets the shortName.
- ThrownExceptionInfo::getLongName – Returns the longName of this instance.
- ThrownExceptionInfo::setLongName – Sets the longName.
- ThrownExceptionInfo::getUrl – Returns the url of this instance.
- ThrownExceptionInfo::setUrl – Sets the url.
- ThrownExceptionInfo::getText – Returns the text of this instance.
- ThrownExceptionInfo::setText – Sets the text.
- DocToolInterpreter – The DocToolInterpreter class is a helper tool to interpret the docTool markup language.
- DocToolInterpreter::__construct – Builds the DocToolInterpreter instance.
- DocToolInterpreter::resolveInlineTags – Resolves the inline tags in the given $string, and returns the result.
- DocToolInterpreter::interpretBlockLevelTags – Interprets the given $tags, and potentially configures the $comment accordingly.
- DocToolInterpreter::setGeneratedItemsToUrl – Sets the generatedItems2Url.
- DocToolInterpreter::setKeyword2UrlMap – Sets the keyword2UrlMap.
- NotationInterpreterInterface – The NotationInterpreterInterface interface represents a notation interpreter.
- NotationInterpreterInterface::resolveInlineTags – Resolves the inline tags in the given $string, and returns the result.
- NotationInterpreterInterface::interpretBlockLevelTags – Interprets the given $tags, and potentially configures the $comment accordingly.
- PageUtil – The PageUtil class is a tool to create pages of your documentation.
- PageUtil::__construct – Builds the PageUtil instance.
- PageUtil::setRootDir – Sets the root dir.
- PageUtil::setInsertsRootDir – Sets the insertsRootDir.
- PageUtil::setTranslator – Sets the translator.
- PageUtil::createPage – Creates the page in $file, based on the given $template and $variables.
- PlanetParser – The PlanetParser class.
- PlanetParser::__construct – Builds the PlanetParser instance.
- PlanetParser::parse – and creates a PlanetReport (retrieved using the getReport method).
- PlanetParser::setClassParser – Sets the class parser.
- PlanetParser::setGeneratedItemsToUrl – Sets the generatedItems2Url.
- PlanetParser::getReport – Returns the report.
- PlanetParser::setReport – Sets the report.
- PlanetParser::setResolveInlineTags – Sets the resolveInlineTags.
- PlanetParser::setNotationInterpreter – Sets the notation interpreter.
- AbstractReport – The AbstractReport class is an abstract implementation of the ReportInterface.
- AbstractReport::__construct – Builds the PlanetReport instance.
- AbstractReport::setCurrentContext – Sets the current context.
- AbstractReport::setIgnore – Sets the ignore array.
- AbstractReport::addParsedInlineFunction – Adds the function name and the args of an inline function.
- AbstractReport::addParsedBlockLevelTag – Adds the block-level tag to an internal collection.
- AbstractReport::addUnknownInlineFunction – Adds an unknown inline function.
- AbstractReport::addUndefinedInlineKeyword – Adds an undefined keyword (defined with the keyword inline function or alike).
- AbstractReport::addUndefinedInlineClass – Adds an undefined class (defined with the class inline function).
- AbstractReport::addUnresolvedImplementationTag – an unresolved @implementation tag.
- AbstractReport::addUnresolvedOverridesTag – an unresolved @overrides tag.
- AbstractReport::addClassWithoutComment – Adds the name of a class which doesn't have a non-empty doc comment.
- AbstractReport::addMethodWithoutComment – Adds the name and the visibility of a method which doesn't have a non-empty doc comment.
- AbstractReport::addMethodWithoutReturnTag – Adds the name of a method which doesn't have a "@return" tag.
- AbstractReport::addParameterWithoutParamTag – Adds the name of a property (and method) which doesn't have a "@param" tag specified.
- AbstractReport::addPropertyWithoutComment – Adds the name and the visibility of a property which doesn't have a non-empty doc comment.
- AbstractReport::addPropertyWithoutVarTag – Adds the name of a property which doesn't have a "@var" tag specified.
- AbstractReport::addUnresolvedClassReference – Adds an unresolved class reference.
- AbstractReport::addUnresolvedMethodReference – Adds an unresolved method reference.
- AbstractReport::addClassWithEmptyMainText – Adds a class with an empty main text.
- AbstractReport::addTodoText – Adds a todo text.
- AbstractReport::addPropertyWithEmptyMainText – Adds a property with an empty main text.
- AbstractReport::addMethodWithEmptyMainText – Adds a method with an empty main text.
- AbstractReport::getParsedInlineFunctions – Returns the array of the inline function parsed during this session.
- AbstractReport::getParsedBlockLevelTags – Returns the array of the block-level tags parsed during this session.
- AbstractReport::getUnknownInlineFunctions – The getUnknownInlineFunctions method
- AbstractReport::getUndefinedInlineKeywords – The getUndefinedInlineKeywords method
- AbstractReport::getUndefinedInlineClasses – The getUndefinedInlineClasses method
- AbstractReport::getUnresolvedImplementationTags – unresolved @implementation tag.
- AbstractReport::getUnresolvedOverridesTags – unresolved @overrides tag.
- AbstractReport::getClassesWithoutComment – don't have a doc comment (or with an empty doc comment).
- AbstractReport::getMethodsWithoutComment – Returns the array of methods without a doc comment (or with an empty doc comment).
- AbstractReport::getMethodsWithoutReturnTag – Returns the array of methods with a doc comment, but without a "@return" tag.
- AbstractReport::getParametersWithoutParamTag – Returns the array of parameters without a "@param" tag.
- AbstractReport::getPropertiesWithoutComment – Returns the array of properties without a doc comment (or with an empty doc comment).
- AbstractReport::getPropertiesWithoutVarTag – Returns the array of properties without a "@var" tag specified.
- AbstractReport::getUnresolvedClassReferences – Returns the array of unresolved class references.
- AbstractReport::getUnresolvedMethodReferences – Returns the array of unresolved method references.
- AbstractReport::getClassesWithEmptyMainText – Returns the array of the classes with an empty main text.
- AbstractReport::getTodoTexts – Returns the array of todo texts.
- AbstractReport::getPropertiesWithEmptyMainText – Returns the array of the properties with an empty main text.
- AbstractReport::getMethodsWithEmptyMainText – Returns the array of the methods with an empty main text.
- ReportInterface::__toString – Builds and returns the rendered report as a string.
- HtmlReport – The HtmlReport class is an html implementation of the ReportInterface.
- HtmlReport::__construct – Builds the HtmlReport instance.
- HtmlReport::setTemplate – Sets the template.
- HtmlReport::setOptions – Sets the options.
- HtmlReport::__toString – Builds and returns the rendered report as an html string.
- AbstractReport::setCurrentContext – Sets the current context.
- AbstractReport::setIgnore – Sets the ignore array.
- AbstractReport::addParsedInlineFunction – Adds the function name and the args of an inline function.
- AbstractReport::addParsedBlockLevelTag – Adds the block-level tag to an internal collection.
- AbstractReport::addUnknownInlineFunction – Adds an unknown inline function.
- AbstractReport::addUndefinedInlineKeyword – Adds an undefined keyword (defined with the keyword inline function or alike).
- AbstractReport::addUndefinedInlineClass – Adds an undefined class (defined with the class inline function).
- AbstractReport::addUnresolvedImplementationTag – an unresolved @implementation tag.
- AbstractReport::addUnresolvedOverridesTag – an unresolved @overrides tag.
- AbstractReport::addClassWithoutComment – Adds the name of a class which doesn't have a non-empty doc comment.
- AbstractReport::addMethodWithoutComment – Adds the name and the visibility of a method which doesn't have a non-empty doc comment.
- AbstractReport::addMethodWithoutReturnTag – Adds the name of a method which doesn't have a "@return" tag.
- AbstractReport::addParameterWithoutParamTag – Adds the name of a property (and method) which doesn't have a "@param" tag specified.
- AbstractReport::addPropertyWithoutComment – Adds the name and the visibility of a property which doesn't have a non-empty doc comment.
- AbstractReport::addPropertyWithoutVarTag – Adds the name of a property which doesn't have a "@var" tag specified.
- AbstractReport::addUnresolvedClassReference – Adds an unresolved class reference.
- AbstractReport::addUnresolvedMethodReference – Adds an unresolved method reference.
- AbstractReport::addClassWithEmptyMainText – Adds a class with an empty main text.
- AbstractReport::addTodoText – Adds a todo text.
- AbstractReport::addPropertyWithEmptyMainText – Adds a property with an empty main text.
- AbstractReport::addMethodWithEmptyMainText – Adds a method with an empty main text.
- AbstractReport::getParsedInlineFunctions – Returns the array of the inline function parsed during this session.
- AbstractReport::getParsedBlockLevelTags – Returns the array of the block-level tags parsed during this session.
- AbstractReport::getUnknownInlineFunctions – The getUnknownInlineFunctions method
- AbstractReport::getUndefinedInlineKeywords – The getUndefinedInlineKeywords method
- AbstractReport::getUndefinedInlineClasses – The getUndefinedInlineClasses method
- AbstractReport::getUnresolvedImplementationTags – unresolved @implementation tag.
- AbstractReport::getUnresolvedOverridesTags – unresolved @overrides tag.
- AbstractReport::getClassesWithoutComment – don't have a doc comment (or with an empty doc comment).
- AbstractReport::getMethodsWithoutComment – Returns the array of methods without a doc comment (or with an empty doc comment).
- AbstractReport::getMethodsWithoutReturnTag – Returns the array of methods with a doc comment, but without a "@return" tag.
- AbstractReport::getParametersWithoutParamTag – Returns the array of parameters without a "@param" tag.
- AbstractReport::getPropertiesWithoutComment – Returns the array of properties without a doc comment (or with an empty doc comment).
- AbstractReport::getPropertiesWithoutVarTag – Returns the array of properties without a "@var" tag specified.
- AbstractReport::getUnresolvedClassReferences – Returns the array of unresolved class references.
- AbstractReport::getUnresolvedMethodReferences – Returns the array of unresolved method references.
- AbstractReport::getClassesWithEmptyMainText – Returns the array of the classes with an empty main text.
- AbstractReport::getTodoTexts – Returns the array of todo texts.
- AbstractReport::getPropertiesWithEmptyMainText – Returns the array of the properties with an empty main text.
- AbstractReport::getMethodsWithEmptyMainText – Returns the array of the methods with an empty main text.
- ReportInterface – The ReportInterface interface is the interface for all reports.
- ReportInterface::setCurrentContext – Sets the name of the current context being parsed.
- ReportInterface::addParsedInlineFunction – Adds the function name and the args of an inline function.
- ReportInterface::addParsedBlockLevelTag – Adds the block-level tag to an internal collection.
- ReportInterface::addUnknownInlineFunction – Adds an unknown inline function.
- ReportInterface::addUndefinedInlineKeyword – Adds an undefined keyword (defined with the keyword inline function or alike).
- ReportInterface::addUndefinedInlineClass – Adds an undefined class (defined with the class inline function).
- ReportInterface::addUnresolvedImplementationTag – an unresolved @implementation tag.
- ReportInterface::addUnresolvedOverridesTag – an unresolved @overrides tag.
- ReportInterface::addClassWithoutComment – Adds the name of a class which doesn't have a non-empty doc comment.
- ReportInterface::addMethodWithoutComment – Adds the name and the visibility of a method which doesn't have a non-empty doc comment.
- ReportInterface::addMethodWithoutReturnTag – Adds the name of a method which doesn't have a "@return" tag.
- ReportInterface::addPropertyWithoutComment – Adds the name and the visibility of a property which doesn't have a non-empty doc comment.
- ReportInterface::addPropertyWithoutVarTag – Adds the name of a property which doesn't have a "@var" tag specified.
- ReportInterface::addParameterWithoutParamTag – Adds the name of a property (and method) which doesn't have a "@param" tag specified.
- ReportInterface::addUnresolvedClassReference – Adds an unresolved class reference.
- ReportInterface::addUnresolvedMethodReference – Adds an unresolved method reference.
- ReportInterface::addClassWithEmptyMainText – Adds a class with an empty main text.
- ReportInterface::addTodoText – Adds a todo text.
- ReportInterface::addPropertyWithEmptyMainText – Adds a property with an empty main text.
- ReportInterface::addMethodWithEmptyMainText – Adds a method with an empty main text.
- ReportInterface::__toString – Builds and returns the rendered report as a string.
- ReportInterface::getParsedInlineFunctions – Returns the array of the inline function parsed during this session.
- ReportInterface::getParsedBlockLevelTags – Returns the array of the block-level tags parsed during this session.
- ReportInterface::getUnknownInlineFunctions – The getUnknownInlineFunctions method
- ReportInterface::getUndefinedInlineKeywords – The getUndefinedInlineKeywords method
- ReportInterface::getUndefinedInlineClasses – The getUndefinedInlineClasses method
- ReportInterface::getUnresolvedImplementationTags – unresolved @implementation tag.
- ReportInterface::getUnresolvedOverridesTags – unresolved @overrides tag.
- ReportInterface::getClassesWithoutComment – don't have a doc comment (or with an empty doc comment).
- ReportInterface::getMethodsWithoutComment – Returns the array of methods without a doc comment (or with an empty doc comment).
- ReportInterface::getMethodsWithoutReturnTag – Returns the array of methods with a doc comment, but without a "@return" tag.
- ReportInterface::getParametersWithoutParamTag – Returns the array of parameters without a "@param" tag.
- ReportInterface::getPropertiesWithoutComment – Returns the array of properties without a doc comment (or with an empty doc comment).
- ReportInterface::getPropertiesWithoutVarTag – Returns the array of properties without a "@var" tag specified.
- ReportInterface::getUnresolvedClassReferences – Returns the array of unresolved class references.
- ReportInterface::getUnresolvedMethodReferences – Returns the array of unresolved method references.
- ReportInterface::getClassesWithEmptyMainText – Returns the array of the classes with an empty main text.
- ReportInterface::getTodoTexts – Returns the array of todo texts.
- ReportInterface::getPropertiesWithEmptyMainText – Returns the array of the properties with an empty main text.
- ReportInterface::getMethodsWithEmptyMainText – Returns the array of the methods with an empty main text.
- TemplateWizard – The TemplateWizard class.
- TemplateWizard::__construct – Builds the TemplateWizard instance.
- TemplateWizard::hasInsert – Returns whether an insert of the given $type exists.
- TemplateWizard::getInserts – Returns an array of inserts for the given $type.
- MarkdownTranslatorInterface – The MarkdownTranslatorInterface interface.
- MarkdownTranslatorInterface::translate – and returns the result.
- ParseDownTranslator – The MarkdownTranslatorInterface interface.
- ParseDownTranslator::translate – and returns the result.
- Parsedown::text – The text method
- Parsedown::setBreaksEnabled – The setBreaksEnabled method
- Parsedown::setMarkupEscaped – The setMarkupEscaped method
- Parsedown::setUrlsLinked – The setUrlsLinked method
- Parsedown::setSafeMode – The setSafeMode method
- Parsedown::setStrictMode – The setStrictMode method
- Parsedown::line – The line method
- Parsedown::parse – The parse method
- Parsedown::instance – The instance method
- ClassMethodsWidget – The ClassMethodsWidget class.
- ClassMethodsWidget::__construct – Builds the ClassMethodsWidget instance.
- ClassMethodsWidget::setClassInfo – Sets the classInfo.
- ClassMethodsWidget::setGeneratedItemsToUrl – Sets the generatedItems2Url.
- ClassMethodsWidget::setReport – Sets the report.
- ClassMethodsWidget::render – Returns the rendered widget.
- Widget::setOptions – Sets the options for this widget instance.
- ClassPrevNextWidget – The ClassPrevNextWidget class.
- ClassPrevNextWidget::__construct – Builds the ClassMethodsWidget instance.
- ClassPrevNextWidget::setClassInfo – Sets the classInfo.
- ClassPrevNextWidget::setPlanetInfo – Sets the planetInfo.
- ClassPrevNextWidget::setGeneratedItemsToUrl – Sets the generatedItems2Url.
- ClassPrevNextWidget::setReport – Sets the report.
- ClassPrevNextWidget::render – Returns the rendered widget.
- Widget::setOptions – Sets the options for this widget instance.
- ClassPropertiesWidget – The ClassPropertiesWidget class.
- ClassPropertiesWidget::__construct – Builds the ClassPropertiesWidget instance.
- ClassPropertiesWidget::setClassInfo – Sets the classInfo.
- ClassPropertiesWidget::render – Returns the rendered widget.
- Widget::setOptions – Sets the options for this widget instance.
- ClassSynopsisWidget – The ClassSynopsisWidget class.
- ClassSynopsisWidget::__construct – Builds the ClassSynopsisWidget instance.
- ClassSynopsisWidget::setGeneratedItems2Url – Sets the generatedItems2Url.
- ClassSynopsisWidget::setReport – Sets the report.
- ClassSynopsisWidget::setClassInfo – Sets the classInfo.
- ClassSynopsisWidget::render – Returns the rendered widget.
- Widget::setOptions – Sets the options for this widget instance.
- MethodPrevNextWidget – The MethodPrevNextWidget class.
- MethodPrevNextWidget::__construct – Builds the ClassMethodsWidget instance.
- MethodPrevNextWidget::setClassInfo – Sets the classInfo.
- MethodPrevNextWidget::setMethodInfo – Sets the methodInfo.
- MethodPrevNextWidget::setGeneratedItemsToUrl – Sets the generatedItems2Url.
- MethodPrevNextWidget::setReport – Sets the report.
- MethodPrevNextWidget::render – Returns the rendered widget.
- Widget::setOptions – Sets the options for this widget instance.
- PlanetDependenciesSectionWidget – The PlanetDependenciesSectionWidget class.
- PlanetDependenciesSectionWidget::__construct – Builds the PlanetDependenciesSectionWidget instance.
- PlanetDependenciesSectionWidget::setPlanetInfo – Sets the planet info.
- PlanetDependenciesSectionWidget::render – Returns the rendered widget.
- Widget::setOptions – Sets the options for this widget instance.
- PlanetTocListWidget – This PlanetTocListWidget widget displays a list of each class of the planet and their methods.
- PlanetTocListWidget::__construct – Builds the PlanetTocListWidget instance.
- PlanetTocListWidget::setPlanetInfo – Sets the planet info.
- PlanetTocListWidget::render – Returns the rendered widget.
- Widget::setOptions – Sets the options for this widget instance.
- Widget – A base widget that every widget can extend.
- Widget::__construct – Builds the Widget instance.
- Widget::setOptions – Sets the options for this widget instance.
- WidgetInterface::render – Returns the rendered widget.
- WidgetInterface – The interface for all DocTools widgets.
- WidgetInterface::render – Returns the rendered widget.