MCPcopy Create free account

hub / github.com/Abnaxos/markdown-doclet / types & classes

Types & classes137 in github.com/Abnaxos/markdown-doclet

ClassAllOf
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/PredefinedArgumentValidators.java:428
ClassAnyOf
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/PredefinedArgumentValidators.java:457
InterfaceArgumentConverter
Convert a single argument to a Java object. @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/options/ArgumentConverter.java:9
InterfaceArgumentListPredicate
ArgumentListPredicate is a Predicate Functor for {@link PredefinedArgumentValidators#argumentTypesValidator(String, ArgumentListPredicate)}. @see Mar
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/ArgumentListPredicate.java:33
ClassArgumentPredicate
# ArgumentPredicate validates a single argument value. @see PredefinedArgumentValidators#argumentTypeValidator(String, IndexFilter, ArgumentPredicate
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/ArgumentPredicate.java:29
ClassArgumentTypesValidator
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/PredefinedArgumentValidators.java:406
InterfaceArgumentValidator
A {@link MarkdownTaglet} argument validator validates the arguments before {@link MarkdownTaglet#render(List)} will be called. If the argument's are
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/ArgumentValidator.java:39
ClassArgumentValidatorBase
ArgumentValidatorBase is responsible for ...
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/ArgumentValidatorBase.java:29
ClassArgumentsProcessingException
Runtime exception thrown when a runtime error occurs during options processing. This is usually a programming error. @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/options/ArgumentsProcessingException.java:9
ClassAtSymbolRepair
AtSymbolRepair allows to use the '@' symbol in external JavaDoc fragments (like the Gist Taglet) without running into any issues with JavaDoc. Impo
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdrepair/AtSymbolRepair.java:39
ClassBuilder
core/src/main/java/ch/raffael/mddoclet/core/options/OptionDescriptor.java:57
ClassBuilder
core/src/main/java/ch/raffael/mddoclet/core/options/Option.java:80
ClassCellRenderer
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/MarkdownDocletOptionsForm.java:268
ClassCharStream
core/src/main/java/ch/raffael/mddoclet/core/options/files/StreamOptionsLexer.java:215
ClassCharsets
Some utilities for choosing the charsets. @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/util/Charsets.java:13
ClassClasses
@author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/util/Classes.java:6
ClassCounter
doclet/jdk8/src/main/java/ch/raffael/mddoclet/tags/TodoTagRenderer.java:96
ClassDataStore
A mutable {@link ImmutableDataStore data store}. @see ImmutableDataStore @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/util/DataStore.java:15
ClassDefaultKey
core/src/main/java/ch/raffael/mddoclet/core/util/ImmutableDataStore.java:97
ClassDefaultMarkdownRepair
DefaultMarkdownRepair provides default implementation.
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdrepair/DefaultMarkdownRepair.java:25
ClassDocCommentProcessor
The work-horse, renders the JavaDoc comments using Markdown and creates a new PsiDocComment that can be passed to IDEA's default QuickDoc implementati
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/DocCommentProcessor.java:79
ClassDocNode
Generic doc node. Most of the node types are represented by objects of this class, specifically: {@link DocNode.Type.TEXT TEXT} {@link DocNode.T
core/src/main/java/ch/raffael/mddoclet/core/ast/DocNode.java:23
ClassDocNodeList
A list of nodes. This list also takes care of re-parenting the nodes on add or remove. @todo Needs a spec. @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/ast/DocNodeList.java:21
InterfaceDocNodeVisitor
Visitor for {@link DocNode}s. @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/ast/DocNodeVisitor.java:8
ClassDocletLinkRenderer
The default link renderer for this doclet. It overrides the rendering of Wiki-Style links to support the following scheme: `[[http://www.example.com
doclet/jdk8/src/main/java/ch/raffael/mddoclet/tags/DocletLinkRenderer.java:40
ClassDocletSerializer
Customises the HTML rendering. @author <a href="mailto:herzog@raffael.ch">Raffael Herzog</a>
doclet/jdk8/src/main/java/ch/raffael/mddoclet/DocletSerializer.java:31
ClassEachArgumentTypeValidator
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/PredefinedArgumentValidators.java:381
ClassEnumArgumentConverter
core/src/main/java/ch/raffael/mddoclet/core/options/StandardArgumentConverters.java:143
ClassEnumSetArgumentConverter
core/src/main/java/ch/raffael/mddoclet/core/options/StandardArgumentConverters.java:173
ClassEnumSetOption
A special option type that adds or removes elements from collections of enum values (usually sets). @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/options/EnumSetOption.java:16
ClassErrorHandlerImpl
The implementation of {@link MarkdownTagletErrorHandler} using {@link DocErrorReporter}.
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/MarkdownTaglets.java:210
ClassExceptions
TODO: 20.11.17 Javadoc? @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/util/Exceptions.java:11
ClassFindDeepestSuperMethodsInterceptor
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/PsiProxy.java:127
ClassGetDocCommentInterceptor
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/PsiProxy.java:344
ClassGetListTypesInterceptor
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/PsiProxy.java:85
ClassGetNavigationElementInterceptor
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/PsiProxy.java:364
ClassGetParameterParentInterceptor
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/PsiProxy.java:168
ClassGetParentInterceptor
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/PsiProxy.java:375
ClassGistMarkdownTaglet
# GistMarkdownTaglet is the implementation for &#123;&#123;gist ...&#125;&#125;.
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdt/gist/GistMarkdownTaglet.java:57
ClassGithubAccessor
# GithubAccessor is responsible for accessing Github's API. GithubAccessor provides/is responsible + creating a Github API instance with credentials
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdt/gist/GithubAccessor.java:44
ClassHelloTaglet
# HelloTaglet is a sample {@link MarkdownTaglet}. It's say Hello in English (language='EN') or Ciao in Italian (language='IT') to the people in the a
doclet/jdk8/src/test/java/mdtaglets/HelloTaglet.java:35
ClassHtmlEntitiesRepair
HtmlEntitiesRepair support the possibility of escaping html entities, even in code blocks - `{&any code;}`.
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdrepair/HtmlEntitiesRepair.java:30
ClassImmutableDataStore
A type-safe data store for any data. Can be used to attach arbitrary data to objects that provide a data store. The date store is designed such that
core/src/main/java/ch/raffael/mddoclet/core/util/ImmutableDataStore.java:27
ClassIndexFilter
IndexFilter filters valid indices. @see PredefinedArgumentValidators#argumentTypeValidator(String, IndexFilter, ArgumentPredicate)
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/IndexFilter.java:31
ClassIndexListFilter
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/IndexFilter.java:205
ClassInlineTagletRepair
InlineTagletRepair handle issues with inline taglets like &#123;@link ...&#125; .
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdrepair/InlineTagletRepair.java:31
ClassIntegerPredicate
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/PredefinedArgumentPredicates.java:246
ClassInterceptor
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/PsiProxy.java:280
ClassInvalid
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/ValidationResult.java:177
ClassInvalidOptionArgumentsException
Exception thrown when something's wrong with the options. This is usually a user error and should be handled gracefully (i.e. nice, human-presentable
core/src/main/java/ch/raffael/mddoclet/core/options/InvalidOptionArgumentsException.java:10
ClassInvoker
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/PsiProxy.java:313
ClassIssue44_TopTitleNotProcessed
doclet/jdk8/src/test/javadoc/testdocs/issue44_topTitleNotProcessed/Issue44_TopTitleNotProcessed.java:3
EnumJavadocQuirks
doclet/jdk8/src/main/java/ch/raffael/mddoclet/Options.java:613
InterfaceKey
core/src/main/java/ch/raffael/mddoclet/core/util/ImmutableDataStore.java:93
ClassLexer
@author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/ast/Lexer.java:18
ClassLinkExpander
Because the PsiDocComment returned is rooted in a method without any root, resolving relative links like `{{@literal @}link #myMethod}` won't be resol
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/DocCommentProcessor.java:470
ClassMarkdownConfigurable
Adds the plugin's configuration panel to "Settings -- Markdown Doclet". @author <a href="mailto:herzog@raffael.ch">Raffael Herzog</a>
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/MarkdownConfigurable.java:35
ClassMarkdownDoclet
The Doclet implementation. This implementation uses [Pegdown](http://www.pegdown.org/) to process the JavaDoc comments and tags, and sets a new JavaDo
doclet/jdk8/src/main/java/ch/raffael/mddoclet/MarkdownDoclet.java:69
ClassMarkdownDocletOptionsForm
The project options form. @author <a href="mailto:herzog@raffael.ch">Raffael Herzog</a>
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/MarkdownDocletOptionsForm.java:66
ClassMarkdownDocumentationProvider
A documentation provider that renders the JavaDoc comments using Markdown. @author <a href="mailto:herzog@raffael.ch">Raffael Herzog</a>
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/MarkdownDocumentationProvider.java:46
ClassMarkdownJavaDocInfoGenerator
Overrides `generateCommonSection()` to enable rendering of doc comments using the {@link DocCommentProcessor}. @author <a href="mailto:herzog@raffael
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/MarkdownJavaDocInfoGenerator.java:33
ClassMarkdownOptions
A holder for the markdown options. @author <a href="mailto:herzog@raffael.ch">Raffael Herzog</a>
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/MarkdownOptions.java:49
InterfaceMarkdownRepair
# MarkdownRepair _repairs_ or _corrects_ the markdown/markup. Markdown and Javadoc do not always work smoothly together. All (local) implementation
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdrepair/MarkdownRepair.java:42
ClassMarkdownRepairKit
MarkdownRepairKit provides a repair kit for Makdown/Javadoc integration obstacles.
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdrepair/MarkdownRepairKit.java:31
InterfaceMarkdownTaglet
# MarkdownTaglet represents a single markdown tag. A markdown tag has a + {@linkplain #getName() name}, which identifies your tag. _Caution_: case s
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/MarkdownTaglet.java:49
ClassMarkdownTagletBase
# MarkdownTagletBase is the default base class implementation for {@link MarkdownTaglet}. Every markdown taglet should be extend this base class. It
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/MarkdownTagletBase.java:45
InterfaceMarkdownTagletErrorHandler
Error and warning handler interface.
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/MarkdownTagletErrorHandler.java:28
ClassMarkdownTagletExecutor
MarkdownTagletExecutor is responsible for extracting inline tags for each {@linkplain #register(MarkdownTaglet) registered} {@link MarkdownTaglet}, an
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/MarkdownTagletExecutor.java:41
ClassMarkdownTagletUtils
MarkdownTagletUtils is an utility class.
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/MarkdownTagletUtils.java:27
ClassMarkdownTaglets
# MarkdownTaglets contains the glue code for handling the {@link MarkdownTaglet}s. + It's a singleton. + It handles the registration and initializati
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/MarkdownTaglets.java:46
ClassMdDoclet
TODO: 02.04.18 Javadoc? @author Raffael Herzog
doclet/jdk9/src/main/java/ch/raffael/mddoclet/jdk9/MdDoclet.java:20
ClassMdDocletEnvironment
TODO: 02.04.18 Javadoc? @author Raffael Herzog
doclet/jdk9/src/main/java/ch/raffael/mddoclet/jdk9/mdproxy/MdDocletEnvironment.java:8
ClassMissingArgumentsValidator
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/PredefinedArgumentValidators.java:492
EnumModuleConfComboBoxEntry
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/MarkdownDocletOptionsForm.java:388
ClassModuleConfiguration
A module component holding the module-specific configuration. @author <a href="mailto:herzog@raffael.ch">Raffael Herzog</a>
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/ModuleConfiguration.java:36
ClassModuleTableEntry
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/MarkdownDocletOptionsForm.java:232
ClassModulesTableModel
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/MarkdownDocletOptionsForm.java:194
ClassOption
Represents an option and its arguments. @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/options/Option.java:16
ClassOptionDescriptor
@author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/options/OptionDescriptor.java:13
InterfaceOptionProcessor
@author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/options/OptionProcessor.java:12
ClassOptionSet
TODO: 17.11.17 Javadoc? @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/options/OptionSet.java:21
ClassOptions
Processes and stores the command line options. @author <p><a href="mailto:herzog@raffael.ch">Raffael Herzog</a></p>
doclet/jdk8/src/main/java/ch/raffael/mddoclet/Options.java:53
ClassOptionsAction
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/RenderingOptionsForm.java:340
ClassParamTagRenderer
Renderer for `@param` tags. @author <a href="mailto:herzog@raffael.ch">Raffael Herzog</a>
doclet/jdk8/src/main/java/ch/raffael/mddoclet/tags/ParamTagRenderer.java:31
ClassParseException
core/src/main/java/ch/raffael/mddoclet/core/options/files/StreamOptionsLexer.java:328
ClassParser
@author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/ast/Parser.java:13
ClassPlugin
Some utilities for the plugin. @author <a href="mailto:herzog@raffael.ch">Raffael Herzog</a>
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/Plugin.java:31
ClassPredefinedArgumentPredicates
# PredefinedArgumentPredicates provides predefined {@link ArgumentPredicate} factory methods. Some of regular expression based {@link ArgumentPredica
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/PredefinedArgumentPredicates.java:48
ClassPredefinedArgumentValidators
# PredefinedArgumentValidators is the utility class, to create {@link ArgumentValidator} instances. These could be used for implementation of {@link
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/PredefinedArgumentValidators.java:75
EnumPredefinedWhiteSpacePreserver
PredefinedWhiteSpacePreserver is responsible for ...
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/PredefinedWhiteSpacePreserver.java:28
ClassProjectConfiguration
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/ProjectConfiguration.java:37
ClassPsiClassTypeProxy
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/PsiProxy.java:408
ClassPsiProxy
Wraps PSI elements and intercepts certain methods. This is used to render method and parameter documentations, as there is no easy way to intercept th
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/PsiProxy.java:55
EnumRadix
Radix values for {@link #isInteger(Radix)} and Co.
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/PredefinedArgumentPredicates.java:217
ClassRangeIndexFilter
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/IndexFilter.java:189
ClassReflectedOptions
Provides the tools to scan objects/methods for the {@link OptionConsumer @Option} annotation and return option processors or descriptors for it. @aut
core/src/main/java/ch/raffael/mddoclet/core/options/ReflectedOptions.java:18
ClassReflectionException
Exception thrown when some unexpected reflection error occurs. This usually indicates programming errors. @author Raffael Herzog
core/src/main/java/ch/raffael/mddoclet/core/util/ReflectionException.java:9
ClassRegexArgumentPredicate
doclet/jdk8/src/main/java/ch/raffael/mddoclet/mdtaglet/argval/PredefinedArgumentPredicates.java:232
ClassRenderingOptions
Holds the rendering options.
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/MarkdownOptions.java:113
ClassRenderingOptionsForm
The rendering options form. @author <a href="mailto:herzog@raffael.ch">Raffael Herzog</a>
integrations/idea-plugin/src/main/java/ch/raffael/mddoclet/integrations/idea/RenderingOptionsForm.java:46
next →1–100 of 137, ranked by callers