faylixe / marklet

Marklet is a custom Java Doclet which aims to generate a Javadoc in a markdown format which is ready to use in GitHub.

marklet's Issues

@inheritedDoc removal

Remove methods that are inherited without additional documentation.

Generic type linking

Implements generic type link generation.

Fields rendering

Add summary as detail as well.

Constructor link

Constructor link faces some issues :

• Parameterless constructor does not render well (anchor conflict with page header).
• Constructor name is rendered as an anchor link.

Inherited method

Adds inherited method to the class summary section.

Make LINK_EXTENSION and FILE_EXTENSION configurable

I think there are scenarios (like for Slate) where you'd want to have .html.md, but for GitHub pages, .md all the way is the right way.

I introduced this mess, and I will send a patch fixing it 😉

Internal anchor link generation

Link to anchor are not correctly generated when external type are referenced.

Marklet + Android Studio (IntelliJ)

I'm wondering if there's an easy way of integrating this to Android Studio, or any IntelliJ IDE for that matter.

As it stands, I'm generating my POM file through Gradle, and wouldn't necessarily know how to add the required settings into the POM file after the fact. Here's some code:

pomXml = {
        final dependenciesNode = asNode().appendNode('dependencies')
        ext.addDependency = { Dependency dep, String scope ->
            if (dep.group == null || dep.version == null || dep.name == null || dep.name == "unspecified")
                return // ignore invalid dependencies
            final dependencyNode = dependenciesNode.appendNode('dependency')
            dependencyNode.appendNode('groupId', dep.group)
            dependencyNode.appendNode('artifactId', dep.name)
            dependencyNode.appendNode('version', dep.version)
            dependencyNode.appendNode('scope', scope)
            if (!dep.transitive) {
                // If this dependency is not transitive, we should force exclude all its dependencies from the POM
                final exclusionNode = dependencyNode.appendNode('exclusions').appendNode('exclusion')
                exclusionNode.appendNode('groupId', '*')
                exclusionNode.appendNode('artifactId', '*')
            } else if (!dep.properties.excludeRules.empty) {
                // Otherwise add specified exclude rules
                final exclusionNode = dependencyNode.appendNode('exclusions').appendNode('exclusion')
                dep.properties.excludeRules.each { ExcludeRule rule ->
                    exclusionNode.appendNode('groupId', rule.group ?: '*')
                    exclusionNode.appendNode('artifactId', rule.module ?: '*')
                }
            }
        }
        configurations.api.getDependencies().each { dep -> addDependency(dep, "compile") }
        configurations.implementation.getDependencies().each { dep -> addDependency(dep, "runtime") }
    }

Thanks!

@Link processing

Add inline rendenring for @link tags.

Finalizes method / constructor linking

Finalizes method / constructor linking into Summary section.

Marklet not available on Maven Central

It has been a couple of days since the 1.1.0 release has been cut, but http://repo1.maven.org/maven2/fr/faylixe/marklet/ is still missing a 1.1.0 folder. I'd either try to re-do the upload to Maven Central or change the documentation to include a repository that does have 1.1.0